Skip to content

Commit

Permalink
Add notice for ppl reading the doc on github
Browse files Browse the repository at this point in the history
github does not parse sphinx, only basic rst.
  • Loading branch information
feth committed May 30, 2016
1 parent cca3188 commit 60dc674
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ So I've got this easy badge: |requirements|.
Doc contents
-------------

(if toctree is not displayed, then build the docs with sphinx or read them on readthedocs : |docs|.

.. toctree::
:numbered:
:maxdepth: 2
Expand Down

0 comments on commit 60dc674

Please sign in to comment.