sphinxcontrib-versioning
latest

General

  • Installation
  • Tutorial
  • Banner Message
  • Settings
  • HTML Context API
  • Supported Themes

Web Hosting

  • GitHub Pages
  • NearlyFreeSpeech.NET

Appendix

  • Changelog
sphinxcontrib-versioning
  • Docs »
  • SCVersioning 2.2.1
  • Edit on GitHub

SCVersioning 2.2.1¶

A Sphinx extension that lets you build Sphinx docs for all versions of your project without needing special hosting services.

A Few Examples

alabaster

alabaster

sphinx_rtd_theme

sphinx_rtd_theme

classic

classic

nature

nature

Project Links¶

  • Documentation: https://robpol86.github.io/sphinxcontrib-versioning
  • Source code: https://github.com/Robpol86/sphinxcontrib-versioning
  • PyPI homepage: https://pypi.python.org/pypi/sphinxcontrib-versioning

General

  • Installation
    • Pip Install
    • Latest from GitHub
    • Clone and Install
  • Tutorial
    • Building Docs Locally
      • Build All Versions
    • Pushing to Remote Branch
      • Push All Versions
  • Banner Message
  • Settings
    • Global Options
    • Common Positional Arguments
    • Build Arguments
      • Positional Arguments
      • Options
    • Push Arguments
      • Positional Arguments
      • Options
  • HTML Context API
    • Versions Iterable
    • Functions
    • Banner Variables
    • Other Variables
  • Supported Themes

Web Hosting

  • GitHub Pages
    • Turn Off Jekyll
    • Running in CI
    • SSH Key
  • NearlyFreeSpeech.NET
    • Running in CI
    • Create an NFSN Site
    • Pushing From CI to NFSN
    • Robots and 404 Pages

Appendix

  • Changelog
Next

© Copyright 2019, @Robpol86 Revision 0b562109.

Built with Sphinx using a theme provided by Read the Docs.