dvm
docs-versions-menu
pypi i docs-versions-menu
dvm

docs-versions-menu

A versions menu for Sphinx-based documentation

by Michael Goerz

0.5.0rc2 (see all)License:MIT license
pypi i docs-versions-menu
Readme

==================

Docs-Versions-Menu

.. image:: https://img.shields.io/badge/goerz-docs__versions__menu-blue.svg?logo=github :alt: Source code on Github :target: https://github.com/goerz/docs_versions_menu

.. image:: https://img.shields.io/badge/docs-gh--pages-blue.svg :alt: Documentation :target: https://goerz.github.io/docs_versions_menu/

.. image:: https://img.shields.io/pypi/v/docs_versions_menu.svg :alt: docs-versions-menu on the Python Package Index :target: https://pypi.org/project/docs-versions-menu

.. image:: https://img.shields.io/conda/vn/conda-forge/docs-versions-menu.svg :alt: docs-versions-menu on conda-forge :target: https://anaconda.org/conda-forge/docs-versions-menu

.. image:: https://github.com/goerz/docs_versions_menu/workflows/Docs/badge.svg?branch=master :alt: Docs :target: https://github.com/goerz/docs_versions_menu/actions?query=workflow%3ADocs

.. image:: https://github.com/goerz/docs_versions_menu/workflows/PyPI/badge.svg?branch=master :alt: PyPI :target: https://github.com/goerz/docs_versions_menu/actions?query=workflow%3APyPI

.. image:: https://github.com/goerz/docs_versions_menu/workflows/Tests/badge.svg?branch=master :alt: Tests :target: https://github.com/goerz/docs_versions_menu/actions?query=workflow%3ATests

.. image:: https://codecov.io/gh/goerz/docs_versions_menu/branch/master/graph/badge.svg :alt: Codecov :target: https://codecov.io/gh/goerz/docs_versions_menu

.. image:: https://img.shields.io/badge/License-MIT-green.svg :alt: MIT License :target: https://opensource.org/licenses/MIT

A versions-menu for Sphinx_-based documentation.

Historically, many open source projects have hosted their documentation on Read the Docs (RTD). However, RTD has a fixed build process <https://docs.readthedocs.io/en/stable/builds.html> that is essentially limited to just running Sphinx_. Moreover, RTD will inject advertisements into your documentation.

A more flexible approach is to build the documentation with continuous integration (e.g., Github Actions) and to deploy the result to Github Pages or any other static site hosting. There are no restrictions on the build process: it may involve make, tox, latex, or any number of custom scripts to augment Sphinx.

The one difficulty that comes with self-hosting project documentation is that out of the box, there is no support for showing multiple releases or branches of the project. This project aims to remedy this. It provides a Sphinx extension and a command-line tool that work together to generate a dynamic versions-menu similar to that on RTD pages.

.. image:: https://raw.githubusercontent.com/goerz/docs_versions_menu/master/docs/_static/docs-versions-menu-screenshot.png :alt: Docs-Versions-Menu Screenshot

The different "Versions" derive from the folder structure of the hosted documentation, e.g., for Github Pages_, the folders in the root of the gh-pages branch. The docs-versions-menu command-line tool, running on the gh-pages branch or on the server hosting the documentation, collects the available versions based on the folders it sees.

The docs_versions_menu Sphinx extension, running during the Sphinx build process, adds Javascript to the documentation that will inject a menu to switch between the found versions. It can also show warnings for outdated or unreleased versions.

See the Docs-Versions-Menu documentation itself for a live example <online_>_.

Development of Docs-Versions-Menu happens on Github. You can read the full documentation online.

Installation

To install the latest released version of docs-versions-menu, run:

.. code-block:: shell

pip install docs-versions-menu

Or, to install the latest development version of docs-versions-menu from Github_:

.. code-block:: shell

pip install git+https://github.com/goerz/docs_versions_menu.git@master#egg=docs_versions_menu

The docs-versions-menu package can also be installed through conda, using the conda-forge channel. See the instructions in the Docs-Versions-Menu Feedstock <conda-feedstock-instructions_>_.

Usage

Showing a versions-menu in your documentation requires two steps:

  1. Add 'docs_versions_menu' to the list of extensions in your Sphinx conf.py.

    This adds Javascript to your rendered documentation that displays a dynamic versions-menu based on information in a versions.json file it expects to find in the webroot of the hosted documentation, e.g. the root of the gh-pages branch.

  1. Set up the deployment of the documentation such that it runs the docs-versions-menu command in the webroot.

    The command creates the file versions.json that step 1 depends on by analyzing the folders it finds in the webroot.

    How to invoke docs-versions-menu this depends on the specifics of how the documentation is deployed:

    • For Github Actions deploying to Github Pages, check out the gh-pages branch, run docs-versions-menu, and commit and push the resulting files.

    • For Travis deploying to Github Pages with Doctr_, tell doctr deploy to invoke the docs-versions-menu command:

      .. code-block:: shell

      doctr deploy --command=docs-versions-menu --no-require-master --build-tags "$DEPLOY_DIR"
      
    • For deployments to a static web host, use ssh to run the docs-versions-menu command on the server

See the full documentation <online_>_ on Step 1 and Step 2 for details.

Default assumptions

For projects that follow standard best practices, you should not require any customization beyond the above two steps.

  • Releases should be tagged as e.g. v0.1.0 and deployed to a folder of the same name. That is, a lower case letter v followed by a :PEP:440-compatible version identifier.
  • The master branch should be deployed to a folder master, respectively main to a folder main for projects that use "main" as the default branch name <https://github.blog/changelog/2020-10-01-the-default-branch-for-newly-created-repositories-is-now-main/>_.
  • Any other branch for which documentation is to be deployed should go in a folder matching the branch name.

Examples

The following projects use Docs-Versions-Menu, respectively `its predecessor Doctr-Versions-Menu <Doctr-Versions-Menu-PyPI>`_:

  • Krotov_
  • caproto_
  • pcds-ci-helpers_ (an example of shared Travis CI configurations using docs-versions-menu)
  • lcls-twincat-general_ (among many other PLC projects at the LCLS)

.. _Docs-Versions-Menu: https://pypi.org/project/docs-versions-menu .. _Doctr-Versions-Menu-PyPI: https://pypi.org/project/doctr-versions-menu .. _Github: https://github.com/goerz/docs_versions_menu .. _Github Actions: https://github.com/features/actions .. _Github Pages: https://pages.github.com .. _Sphinx: https://www.sphinx-doc.org/ .. _online: https://goerz.github.io/docs_versions_menu/ .. _Read the Docs: https://readthedocs.org .. _Travis: https://travis-ci.org .. _tox: https://tox.readthedocs.io .. _Doctr: https://drdoctr.github.io .. _Krotov: https://qucontrol.github.io/krotov/ .. _caproto: https://caproto.github.io/caproto/ .. _pcds-ci-helpers: https://github.com/pcdshub/pcds-ci-helpers/blob/d1bb15ace06cfd8fdda3f5ccad0981fcc59dfbe0/travis/shared_configs/doctr-upload.yml .. _lcls-twincat-general: https://pcdshub.github.io/lcls-twincat-general/ .. _conda: https://docs.conda.io .. _conda-forge: https://conda-forge.org .. _conda-feedstock-instructions: https://github.com/conda-forge/docs-versions-menu-feedstock#installing-docs-versions-menu .. _make: https://www.gnu.org/software/make/manual/make.html .. _latex: https://www.latex-project.org

=======

History

0.5.0-rc2 (2021-04-04)

  • Improvements to the workflow and documentation.
  • Update of conda-feedstock_

Use this release to test migration from doctr-versions-menu to docs-versions-menu.

0.5.0-rc1 (2021-03-25)

  • Renamed project to docs-versions-menu (#13_)
  • Changed: Removed support for a config file (#9_)
  • Dropped support for Python 3.5

.. _migration:

Migration from doctr-versions-menu

The doctr-versions-menu package was renamed to docs-versions-menu to reflect that Travis and thus Doctr is no longer a viable option to deploy documentation <TravisDemiseHN_>_. Switching from doctr-versions-menu to docs-versions-menu requires the following steps:

  • Consider switching from Travis to Github Actions
  • Replace the doctr-versions-menu package with docs-versions-menu in the project requirements and the environment files for continous integration.
  • Replace calls to doctr-versions-menu with calls to docs-versions-menu
  • For any project using a doctr-versions-menu.conf file in the gh-pages root, set up equivalent DOCS_VERSIONS_MENU_* environment variables
  • For any project using environment variables to configure the doctr-versions-menu utility, change the DOCTR_VERSIONS_MENU prefix to DOCS_VERSIONS_MENU
  • For any project using a custom doctr-versions-menu.js_t template, rename the file to docs-versions-menu.js_t
  • Rename doctr_versions_menu_conf in your Sphinx conf.py file to docs_versions_menu_conf.

To ease migration, the new docs-versions-menu will still process doctr_versions_menu_conf, DOCTR_VERSIONS_MENU environment variables, and a doctr-versions-menu.js_t template, while emitting a warning. This limited backwards-compatibility may be removed in later versions.

0.4.1 (2021-03-18)

Note: this release was under the project name doctr-versions-menu_.

  • Fixed: The doctr-versions-menu exectuable no longer fails when run outside of a git repository (#15, thanks to `Alexander Blech <@ablech>`_)
  • Fixed: Custom doctr-versions-menu.js_t template were being ignored (#18_)

0.4.0 (2020-12-14)

Note: this release was under the project name doctr-versions-menu_.

  • Added: The label in the top left corner of the version menu can now be configured in conf.py (setting menu_title).
  • Added: --default-branch option, <default-branch> group for folder specifications, and default-branch field in versions.json (#12_)
  • Changed: The default --versions now uses <default-branch>, automatically picking up on either "master" or "main" as the default branch (#12_)
  • Changed: The default template for index.html now automatically forwards to the default-branch (based on the --default-branch option, instead of just "master"), or the first available branch if there is no released version (#12_)

This release addresses two major compatibility issues:

  1. Both git <GitMainDefaultBranch_> and `Github <GithubMainDefaultBranch>`_ have recently switched the name of the default branch from "master" to "main". This release adds support for new projects using "main" as their default branch.
  2. As of December 2020, Travis CI has stopped their support for open source <TravisDemiseHN_>. Consequently, Doctr can no longer be used to deploy documentation at no cost. This release adds rudimentary support for deploying the documenation with Github Actions instead of Doctr, see Deployment with Github Actions <https://goerz.github.io/docs_versions_menu/v0.4.0/command.html#deployment-with-github-actions>.

0.3.0 (2020-08-03)

Note: this release was under the project name doctr-versions-menu_.

  • Added: --no-downloads-file option, downloads_file = False in config. (#4, thanks to `Tyler Pennebaker <@ZryletTC>`_)
  • Fixed: versions.py on gh-pages branch was not being committed (#5_)
  • Fixed: Compatibility with any pyparsing version >= 2.0.2 (#8, thanks to `Hugo Slepicka <@hhslepicka>`_)
  • Added: The doctr-versions-menu executable can now be configured through environment variables. This allows to keep configuration on the source branch, in the .travis.yml file (#6, thanks to `Tyler Pennebaker <@ZryletTC>`_)
  • The Doctr Versions Menu package can now be installed via conda <conda-feedstock_> (thanks to `Hugo Slepicka <@hhslepicka>`_)

0.2.0 (2020-03-14)

Note: this release was under the project name doctr-versions-menu_.

  • Added: --versions option for customizing which folders appear in the versions menu and in which order.
  • Added: --label option for customizing the labels appearing the versions menu
  • Added: --warning option for customizing on which folders specific warnings are displayed
  • Added: --latest option for configuring which folder is the "latest stable release"
  • Added: Write a script versions.py to the root of the gh-pages branch (--write-versions-py option)
  • Changed: unreleased and pre-released versions now show different warnings by default
  • Changed: index.html template is now rendered with full version_data
  • Changed: development/pre-release versions now longer have the "dev" suffix in the versions menu by default
  • Changed: The versions menu now uses the same ordering of versions as Read-the-Docs, by default: the folders are ordered from most current to least current.
  • Changed: internal format of versions.json
  • Removed: --default-branch option. This is replaced by the new --latest option and enhanced template rendering of the index.html
  • Removed: --suffix-unreleased option. This can now be achieved via the --label option

This is a major release that breaks backwards compatibility.

Specifically, due to the changes in versions.json, when upgrading from older versions, it may be necessary to replace doctr-versions-menu.js files in existing folders in a project's gh-pages branch.

0.1.0 (2020-01-11)

  • Initial release of doctr-versions-menu_.

.. doctr-versions-menu: https://pypi.org/project/doctr-versions-menu/ .. _GithubMainDefaultBranch: https://github.blog/changelog/2020-10-01-the-default-branch-for-newly-created-repositories-is-now-main/ .. _GitMainDefaultBranch: https://github.blog/2020-07-27-highlights-from-git-2-28/#introducing-init-defaultbranch .. _Travis: https://travis-ci.org .. _TravisDemiseHN: https://news.ycombinator.com/item?id=25338983 .. _Doctr: https://drdoctr.github.io .. _Github Actions: https://github.com/features/actions .. @ZryletTC: https://github.com/ZryletTC .. @hhslepicka: https://github.com/hhslepicka .. @ablech: https://github.com/ablech/ .. #4: https://github.com/goerz/docs_versions_menu/issues/4 .. #5: https://github.com/goerz/docs_versions_menu/issues/5 .. #6: https://github.com/goerz/docs_versions_menu/issues/6 .. #8: https://github.com/goerz/docs_versions_menu/issues/8 .. #9: https://github.com/goerz/docs_versions_menu/issues/9 .. #12: https://github.com/goerz/docs_versions_menu/issues/12 .. #13: https://github.com/goerz/docs_versions_menu/issues/13 .. #15: https://github.com/goerz/docs_versions_menu/issues/15 .. _#18: https://github.com/goerz/docs_versions_menu/issues/18 .. _conda-feedstock: https://github.com/conda-forge/docs-versions-menu-feedstock#readme

GitHub Stars

16

LAST COMMIT

1yr ago

MAINTAINERS

1

CONTRIBUTORS

2

OPEN ISSUES

4

OPEN PRs

0
VersionTagPublished
0.5.0rc2
1yr ago
0.5.0rc1
1yr ago
No alternatives found
No tutorials found
Add a tutorial