Minor updates to docs:

pypa/pip#9031 is fixed so we can include sphinx in requirements.txt Fixed Makefile so that it will use a virtual environment if one is active. Added some simple directions for building docs.
hoodmane · Dec 16, 2020 · bfe1427 · bfe1427
1 parent e79c1ab
commit bfe1427
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 4 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS =
-SPHINXBUILD = sphinx-build
+SPHINXBUILD = python3 -m sphinx
 SOURCEDIR = .
 BUILDDIR = _build
 

diff --git a/docs/building_the_docs.md b/docs/building_the_docs.md
@@ -0,0 +1,7 @@
+(building_the_docs)=
+# Building the docs
+
+From the directory ``docs``, first install the python dependencies with ``pip install -r requirements-doc.txt``. 
+Then build to build the docs run ``make html``.
+The built documentation will be in the subdirectory ``docs/_build/html``. To view them, cd into ``_build/html`` and start a file server, 
+for instance ``http-server``.
diff --git a/docs/index.rst b/docs/index.rst
@@ -56,6 +56,7 @@ information about the project's organization.
  :caption: Development
 
  building_from_sources.md
+ building_the_docs.md 
  new_packages.md
  contributing.md
  testing.md

diff --git a/docs/requirements-doc.txt b/docs/requirements-doc.txt
@@ -1,6 +1,5 @@
-# Temporarly commented as a workaround for pypa/pip#9031
-# sphinx
+sphinx
 sphinx_rtd_theme
 myst-parser
 sphinxcontrib-napoleon
-distlib # required by micropip
+distlib # required by micropip