diff options
| author | Alexandre Flament <alex@al-f.net> | 2021-04-24 07:14:35 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-24 07:14:35 +0200 |
| commit | a7b9eca98a196052bed8168ff11d13456851b04f (patch) | |
| tree | fcafca4b1c2b95f5e789275d7fd64b9d578c13fb /docs/dev/reST.rst | |
| parent | fe064a5c390f7b85aa0e7b207b38129cca2ccc17 (diff) | |
| parent | abd423cbf8fd221c855eeabc5f3a61b7954e3961 (diff) | |
Merge pull request #8 from return42/manage-script
Replace Makefile boilerplate by shell scripts
Diffstat (limited to 'docs/dev/reST.rst')
| -rw-r--r-- | docs/dev/reST.rst | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst index 39cd9f671..1817504c6 100644 --- a/docs/dev/reST.rst +++ b/docs/dev/reST.rst @@ -15,8 +15,8 @@ generated and deployed at :docs:`github.io <.>`. For build prerequisites read :ref:`docs build`. The source files of Searx's documentation are located at :origin:`docs`. Sphinx -assumes source files to be encoded in UTF-8 by defaul. Run :ref:`make docs-live -<make docs-live>` to build HTML while editing. +assumes source files to be encoded in UTF-8 by defaul. Run :ref:`make docs.live +<make docs.live>` to build HTML while editing. .. sidebar:: Further reading @@ -1276,13 +1276,12 @@ Templating .. sidebar:: Build environment - All *generic-doc* tasks are running in the :ref:`build environment <make - pyenv>`. + All *generic-doc* tasks are running in the :ref:`make install`. Templating is suitable for documentation which is created generic at the build -time. The sphinx-jinja_ extension evaluates jinja_ templates in the :ref:`build -environment <make pyenv>` (with searx modules installed). We use this e.g. to -build chapter: :ref:`engines generic`. Below the jinja directive from the +time. The sphinx-jinja_ extension evaluates jinja_ templates in the :ref:`make +install` (with searx modules installed). We use this e.g. to build chapter: +:ref:`engines generic`. Below the jinja directive from the :origin:`docs/admin/engines.rst` is shown: .. literalinclude:: ../admin/engines.rst |