Skip to content

Corrected README to fix apidoc generation #78

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

Merged
brianjmiller merged 1 commit into from
Jul 24, 2014
Merged

Corrected README to fix apidoc generation #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ It is possible to run all the tests in one go, or just run one part of the tests
## API doc generation
To automatically generate documentation, at the root of the repository run,

sphinx-apidoc -o ./docs/source/ tincan/
sphinx-apidoc -f -o ./docs/source/ tincan/

Then from the `docs/` directory run,

Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
contain the root `toctree` directive.

Welcome to Tin Can Python's documentation!
=========================================
==========================================

Contents:

.. toctree::
:maxdepth: 4

modules
modules

Indices and tables
==================
Expand Down