weeheavy/pelican-theme
1
0
Fork 0
forked from github/pelican
Code Pull requests Activity

Add Invoke tasks for building and serving docs

Browse source
This commit is contained in:
Justin Mayer 2019-11-12 08:36:22 -08:00
commit 535df9cd9c
4 changed files with 28 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/contribute.rst
View file

@ -105,13 +105,15 @@ environments.
Building the docs
-----------------
If you make changes to the documentation, you should preview your changes
before committing them::
If you make changes to the documentation, you should build and inspect your
changes before committing them::
cd docs
make html
invoke docserve
Open ``_build/html/index.html`` in your browser to preview the documentation.
Open http://localhost:8000 in your browser to review the documentation. While
the above task is running, any changes you make and save to the documentation
should automatically appear in the browser, as it live-reloads when it detects
changes to the documentation source files.
Plugin development
------------------