h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-04-26 14:01:13 -03:00
Code Issues Packages Projects Releases Wiki Activity

docs: Build index, tutorial and faq as man pages

Browse Source 
This was clearly intended for index, but because it was called "fish"
it was overwritten by the "fish" command man page.

I also added the tutorial and faq. Both of those might not be *ideal*
as man pages (the tutorial makes references to colors that won't show
up), but it's better to provide them than not.

Hat-tip to @wwared

See #5521.

[ci skip]
This commit is contained in:
Fabian Homborg
2019-06-23 16:13:47 +02:00
parent 8f3a0dcc8b
commit e921bd60c3
2 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
sphinx_doc_src/conf.py
View File

@@ -177,7 +177,11 @@ def get_command_description(path, name):
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, "fish", "fish-shell Documentation", [author], 1)]
man_pages = [
(master_doc, "fish-doc", "fish-shell Documentation", [author], 1),
("tutorial", "fish-tutorial", "fish-shell tutorial", [author], 1),
("faq", "fish-faq", "fish-shell faq", [author], 1),
]
for path in sorted(glob.glob("cmds/*")):
docname = strip_ext(path)
cmd = os.path.basename(docname)