Readme: use 'doc' directory not 'docs'
Specified 'docs' directory does not exist and it is not specified to create one so it is a typo. Change-Id: Ice19c0e3c90ba3a2966deceb821b61aab743f4d3
This commit is contained in:
parent
56f194aea1
commit
3ef034694d
|
@ -27,15 +27,15 @@ Please see the documentation under ``doc/source/`` for development setup
|
||||||
Building the Documentation
|
Building the Documentation
|
||||||
--------------------------
|
--------------------------
|
||||||
|
|
||||||
The documentation is all generated with Sphinx from within the docs directory.
|
The documentation is all generated with Sphinx from within the doc directory.
|
||||||
To generate the full set of HTML documentation::
|
To generate the full set of HTML documentation::
|
||||||
|
|
||||||
cd docs
|
cd doc
|
||||||
make autodoc
|
make autodoc
|
||||||
make html
|
make html
|
||||||
make man
|
make man
|
||||||
|
|
||||||
the results are in the ``docs/build/html`` and ``docs/build/man`` directories
|
the results are in the ``doc/build/html`` and ``doc/build/man`` directories
|
||||||
respectively.
|
respectively.
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue