Skip to content

[don't merge yet] Reference python-docs-theme when building docs without make #333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[don't merge yet] Reference python-docs-theme when building docs without make #333

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions documenting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1468,7 +1468,7 @@ below. You can view the documentation after building the HTML by pointing
a browser at the file :file:`Doc/build/html/index.html`.

You are expected to have installed the latest stable version of
Sphinx_ and blurb_ on your system or in a virtualenv_ (which can be
Sphinx_, blurb_, and python-docs-theme_ on your system or in a virtualenv_ (which can be
created using ``make venv``), so that the Makefile can find the
``sphinx-build`` command. You can also specify the location of
``sphinx-build`` with the ``SPHINXBUILD`` :command:`make` variable.
Expand Down Expand Up @@ -1500,7 +1500,7 @@ See also :file:`Doc/README.rst` for more information.
Without make
------------

Install the Sphinx and blurb packages from PyPI.
Install the Sphinx_, blurb_, and python-docs-theme_ packages from PyPI.

Then, from the ``Doc`` directory, run::

Expand All @@ -1515,3 +1515,4 @@ see the make targets above).
.. _Sphinx: http://sphinx-doc.org/
.. _virtualenv: https://virtualenv.pypa.io/
.. _blurb: https://pypi.org/project/blurb/
.. _python-docs-theme: https://pypi.org/project/python-docs-theme/