zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #370 from jtpio/doc-requirements

Browse Source 
Clarify the steps to build the docs locally
This commit is contained in:
Yuvi Panda
2019-06-13 05:14:09 -07:00
committed by GitHub
parent cd503da874 b4a87b8c62
commit 72b583dc16
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/contributing/docs.rst
View File

@@ -48,11 +48,12 @@ documentation is transformed into HTML, PDF, and any other output format.
__ http://sphinx-doc.org/ __ http://sphinx-doc.org/
__ http://docutils.sourceforge.net/ __ http://docutils.sourceforge.net/
To build the documentation locally, install Sphinx: To build the documentation locally, install the Sphinx dependencies:
.. code-block:: console .. code-block:: console
$ pip install Sphinx $ cd docs/
$ pip install -r requirements.txt
Then from the ``docs`` directory, build the HTML: Then from the ``docs`` directory, build the HTML: