Commits

Thomas Lotze  committed 1289ea1

made the advice on editing files under doc/ more explicit

  • Participants
  • Parent commits 5717bf8

Comments (0)

Files changed (1)

     the top-level ``README.txt`` file and a table of contents pointing to the
     sections of the full documentation. These include generated API
     documentation, some meta information about the package and the change log.
-    Edit this file if you want to add top-level sections such as a narrative
-    package description.
+    Edit this file if you want to add top-level sections, for example.
 
 :doc/narrative.txt:
     The root document of the narrative package documentation. This is intended
     to collect any doc-test files that reside among the Python modules in your
-    source tree. The files need to be listed under the ``toctree`` directive,
+    source tree. You need to list the files under the ``toctree`` directive,
     their document names being of the pattern
     ``<NAMESPACE>.<PACKAGENAME>-<FILENAME>`` (without the ``.txt`` suffix). A
     commented-out example file listing is included.
     A listing of Python eggs (other than Sphinx itself) required to build the
     documentation. This is meant for building the documentation at
     <http://readthedocs.org/>. You'll need to be whitelisted with them in
-    order to be able to use the conventions implemented by tl.pkg.
+    order to be able to use the conventions implemented by tl.pkg. Edit this
+    file whenever your documentation's package dependencies change; you cannot
+    use egg extras here.
 
 
 Building the full documentation