Skip to content

Commit

Permalink
Moving generated man-page to section 3 (#89)
Browse files Browse the repository at this point in the history
If the user generates a man page with sphinx, the auto-generated page is
in section 1. Section 1 is reserved for applications. Libraries belong
in section 3. Adding some rules in conf.py to ensure that the man page
is generated in section 3.

---------

Co-authored-by: Stewart Ferguson <[email protected]>
Co-authored-by: Poruri Sai Rahul <[email protected]>
Co-authored-by: Mark Dickinson <[email protected]>
Co-authored-by: Poruri Sai Rahul <[email protected]>
Co-authored-by: Mark Dickinson <[email protected]>
  • Loading branch information
6 people authored Jun 28, 2024
1 parent 4b4465f commit 0a9e33e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,3 +124,9 @@
# The name of an image file (relative to this directory) to place at the top of
# the title page.
latex_logo = "e-logo-rev.png"

# Grouping the document tree into Man pages. List of tuples
# (startdocname, name, description, authors, section)
man_pages = [
(master_doc, project, project + ' ' + version, 'Enthought', 3)
]

0 comments on commit 0a9e33e

Please sign in to comment.