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

Add autogenerated api docs. #641

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Add autogenerated api docs. #641

wants to merge 7 commits into from

Commits on Aug 21, 2017

  1. Init sphinx docs with sphinx-quickstart. 

    ```
sphinx-quickstart --sep --project=OpenHTF --author="OpenHTF Contributors" \
                  --language=en --ext-viewcode --ext-autodoc --makefile --batchfile --suffix=.rst \
                  --master=index docs
```
    @DanLipsitt
    DanLipsitt committed Aug 21, 2017
    Configuration menu
    Copy the full SHA
    29bf623 View commit details
    Browse the repository at this point in the history

  2. Document how to build the Sphinx docs.

    @DanLipsitt
    DanLipsitt committed Aug 21, 2017
    Configuration menu
    Copy the full SHA
    b7a48a1 View commit details
    Browse the repository at this point in the history

  3. Enable the Sphinx extension that parses Google-style docstrings.

    @DanLipsitt
    DanLipsitt committed Aug 21, 2017
    Configuration menu
    Copy the full SHA
    798aab3 View commit details
    Browse the repository at this point in the history

  4. Use pbr to generate api docs.

    @DanLipsitt
    DanLipsitt committed Aug 21, 2017
    Configuration menu
    Copy the full SHA
    e181aec View commit details
    Browse the repository at this point in the history

  5. Set pbr autogenerated docs dir.

    @DanLipsitt
    DanLipsitt committed Aug 21, 2017
    Configuration menu
    Copy the full SHA
    3a91d4e View commit details
    Browse the repository at this point in the history

  6. Add api docs to index.

    @DanLipsitt
    DanLipsitt committed Aug 21, 2017
    Configuration menu
    Copy the full SHA
    ada2368 View commit details
    Browse the repository at this point in the history

Commits on Sep 5, 2017

  1. Add documentation build to tox.

    @DanLipsitt
    DanLipsitt committed Sep 5, 2017
    Configuration menu
    Copy the full SHA
    88b01eb View commit details
    Browse the repository at this point in the history