twisted / towncrier

Manage the release notes for your project.

Home Page:https://towncrier.readthedocs.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Move master-document manual page to "overview" manual section

bignose-debian opened this issue · comments

The Sphinx configuration currently builds a single manual page, from the entire master document. In conf.py:

man_pages = [(master_doc, "towncrier", "Towncrier Documentation", [author], 1)]

The resulting manual page does not meet the conventions for section 1 of the manual ("User Commands"). (See the man-pages(7) manual page.)

The document should instead be in the manual section 7 ("Overview"), to describe the Towncrier system as a whole.

Here is a patch to address this issue:

modified   docs/conf.py
@@ -133,7 +133,7 @@ latex_documents = [
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "towncrier", "Towncrier Documentation", [author], 1)]
+man_pages = [(master_doc, "towncrier", "Towncrier Documentation", [author], 7)]
 
 
 # -- Options for Texinfo output -------------------------------------------