Skip to content

Commit ce5298d

Browse files
committed
Merge pull request #78 from FishHooks/Sphinx-README-fix
Corrected README to fix apidoc generation
2 parents 80e31e1 + e66e2a2 commit ce5298d

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ It is possible to run all the tests in one go, or just run one part of the tests
6464
## API doc generation
6565
To automatically generate documentation, at the root of the repository run,
6666

67-
sphinx-apidoc -o ./docs/source/ tincan/
67+
sphinx-apidoc -f -o ./docs/source/ tincan/
6868

6969
Then from the `docs/` directory run,
7070

docs/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
contain the root `toctree` directive.
55
66
Welcome to Tin Can Python's documentation!
7-
=========================================
7+
==========================================
88

99
Contents:
1010

1111
.. toctree::
1212
:maxdepth: 4
1313

14-
modules
14+
modules
1515

1616
Indices and tables
1717
==================

0 commit comments

Comments
 (0)