[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Important changes in Docwriter
From: |
Werner LEMBERG |
Subject: |
Re: Important changes in Docwriter |
Date: |
Mon, 04 May 2020 19:17:43 +0200 (CEST) |
Hello Nikhil,
thanks for your quick response.
>> Note that `mkdocs.yml` gets explicitly removed while calling `make
>> dist` (see `builds/toplevel.mk`).
>
> `mkdocs serve` requires the file `mkdocs.yml` to generate the site
> and start up the server.
Yes, but...
> If we want search to be usable locally, I suggest that the file
> `mkdocs.yml` be included in the distribution, and `mkdocs serve` be
> officially documented as a method to serve the site. Of course,
> this will require Python 3 and mkdocs to be available in the
> environment.
... the automatically generated `mkdocs.yml` file doesn't work with
the tarball because it needs the `markdown` directory, which is
intentionally omitted.
How to proceed? Can the `mkdocs.yml` file perhaps be adjusted to make
searching work? Availability of a local search would be definitely a
good thing, and yes, it should also be documented how to get it.
Werner
Re: Important changes in Docwriter,
Werner LEMBERG <=