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/contribution_guide.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/contribution_guide.rst')
| -rw-r--r-- | docs/dev/contribution_guide.rst | 33 |
1 files changed, 11 insertions, 22 deletions
diff --git a/docs/dev/contribution_guide.rst b/docs/dev/contribution_guide.rst index cffbbcae8..ed1c223c5 100644 --- a/docs/dev/contribution_guide.rst +++ b/docs/dev/contribution_guide.rst @@ -132,11 +132,11 @@ Here is an example which makes a complete rebuild: .. code:: sh - $ make docs-clean docs + $ make docs.clean docs.html ... The HTML pages are in dist/docs. -.. _make docs-live: +.. _make docs.live: live build ---------- @@ -144,19 +144,19 @@ live build .. _sphinx-autobuild: https://github.com/executablebooks/sphinx-autobuild/blob/master/README.md -.. sidebar:: docs-clean +.. sidebar:: docs.clean It is recommended to assert a complete rebuild before deploying (use - ``docs-clean``). + ``docs.clean``). Live build is like WYSIWYG. If you want to edit the documentation, its -recommended to use. The Makefile target ``docs-live`` builds the docs, opens +recommended to use. The Makefile target ``docs.live`` builds the docs, opens URL in your favorite browser and rebuilds every time a reST file has been changed. .. code:: sh - $ make docs-live + $ make docs.live ... The HTML pages are in dist/docs. ... Serving on http://0.0.0.0:8000 @@ -169,7 +169,7 @@ argument. E.g to find and use a free port, use: .. code:: sh - $ SPHINXOPTS="--port 0" make docs-live + $ SPHINXOPTS="--port 0" make docs.live ... ... Serving on http://0.0.0.0:50593 ... @@ -180,21 +180,10 @@ argument. E.g to find and use a free port, use: deploy on github.io ------------------- -To deploy documentation at :docs:`github.io <.>` use Makefile target -:ref:`make gh-pages`, which will builds the documentation, clones searx into a sub -folder ``gh-pages``, cleans it, copies the doc build into and runs all the -needed git add, commit and push: +To deploy documentation at :docs:`github.io <.>` use Makefile target :ref:`make +docs.gh-pages`, which builds the documentation and runs all the needed git add, +commit and push: .. code:: sh - $ make docs-clean gh-pages - ... - SPHINX docs --> file://<...>/dist/docs - The HTML pages are in dist/docs. - ... - Cloning into 'gh-pages' ... - ... - cd gh-pages; git checkout gh-pages >/dev/null - Switched to a new branch 'gh-pages' - ... - doc available at --> https://searx.github.io/searx + $ make docs.clean docs.gh-pages |