Browse Source

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
changes/81/20581/1
Pavel Sedlák 9 years ago
parent
commit
3ef034694d
  1. 8
      README.rst

8
README.rst

@ -27,15 +27,15 @@ Please see the documentation under ``doc/source/`` for development setup
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::
cd docs
cd doc
make autodoc
make html
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.
@ -218,4 +218,4 @@ then do what is effectively a 'Simple Match' style match against the creds.
Dependencies
----------------------------------
Ensure an OpenSSL version of 1.0+ is installed.
Ensure an OpenSSL version of 1.0+ is installed.
Loading…
Cancel
Save