Skip to content
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.

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

Add Versions dropdown for v1.0 #70

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,7 @@ docs/*
.DS_Store

# Batch file
make.bat
make.bat

# Requirements text file (used to create a new sphinx-version)
req.txt
1 change: 1 addition & 0 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ make = "*"
breathe = "*"
jinja2 = "*"
sphinx-csharp = {git = "https://github.com/rogerbarton/sphinx-csharp.git", ref = "master"}
sphinx-versioning = "*"
435 changes: 238 additions & 197 deletions Pipfile.lock

Large diffs are not rendered by default.

27 changes: 27 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,30 @@ After installing the requirements you can run:
make latex # for latex
make latexpdf # for latex (will require latexpdf installed)
make # list all the available output format

How to Create a New Sphinx-Version
==================================

Make sure that the Pipfile and the Pipfile.lock files are up to date with the conf.py extensions. This means
that the conf.py section containing `extensions` only contains the extensions needed to build the docs, and
the Pipfile has the same list of extensions. The Pipfile is manually edited, but once the two files are
synchronized then you can run:

.. code:: shell

pipenv lock

This will regenerate the Pipfile.lock file. Once this call completes, then run the following line to generate
a text file from the Pipfile.lock that can be used by `sphinx-versioning`:

.. code:: shell

pipenv requirements > source/req.text

After this, the new version can be created. Run the following line, and it will create a new version of the
docs that can be chosen from the dropdown menu in the sidebar. Change the letters X/Y to be the major/minor
version number for the current version of the docs:

.. code:: shell

sphinx-version vX.Y --venv --requirements req.txt
Empty file.
Loading