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.

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

Jump to bottom

Build Sphinx API docs under TravisCI/Tox using apidoc #1803

Merged
merged 3 commits into from Nov 15, 2018
Merged

Build Sphinx API docs under TravisCI/Tox using apidoc #1803

merged 3 commits into from Nov 15, 2018

Commits on Nov 14, 2018

  1. Build Sphinx API docs under TravisCI/Tox using apidoc 

    We trigger sphinx-apidoc from sphinx's conf.py

In theory this would allow readthedocs to be
used and generate the API documentation *.rst
files on demand.

Uses autodoc_default_values added in Sphinx 1.8.0
    @peterjc
    peterjc committed Nov 14, 2018
    Configuration menu
    Copy the full SHA
    3aef3c5 View commit details
    Browse the repository at this point in the history

  2. Revert "rst-lint on Doc/ folder too", breaks on Sphinx RST 

    This reverts commit e6cc67b.
    @peterjc
    peterjc committed Nov 14, 2018
    Configuration menu
    Copy the full SHA
    fc10719 View commit details
    Browse the repository at this point in the history

  3. TravisCI: run doc8 on our RST files 

    I wanted to check only *.rst with:

$ doc8 -e .rst .

Sadly this is broken by design, the bug is that as per
their README file, the "extension" option does not
override, but merges, so cannot remove anything from
the default of .rst and .txt files.
    @peterjc
    peterjc committed Nov 14, 2018
    Configuration menu
    Copy the full SHA
    62fdeda View commit details
    Browse the repository at this point in the history