From 3ef034694d5917251c44f6255d3342a506aa18ae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pavel=20Sedl=C3=A1k?= Date: Mon, 28 Jan 2013 09:44:01 +0100 Subject: [PATCH] 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 --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index a06edbc5ab..c0b3e7225f 100644 --- a/README.rst +++ b/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. \ No newline at end of file +Ensure an OpenSSL version of 1.0+ is installed.