Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
bignose-debian opened this issue Jan 18, 2023 · 1 comment · Fixed by #470
Closed

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

bignose-debian opened this issue Jan 18, 2023 · 1 comment · Fixed by #470

Comments

@bignose-debian
Copy link
Contributor

bignose-debian commented Jan 18, 2023

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.

@bignose-debian
Copy link
Contributor Author

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 -------------------------------------------

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant