jacobpascual/openzfs-docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Set link for man pages' source

Browse Source 
So, contributors can get fast to source of our man pages.

Signed-off-by: George Melikov <mail@gmelikov.ru>
This commit is contained in:
George Melikov
2021-10-24 00:38:05 +03:00
parent 3c04e929a1
commit 0fb4f1c6f0
1 changed files with 18 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
scripts/man_pages.py
View File

@@ -27,6 +27,7 @@ import sys
LOG = logging.getLogger() LOG = logging.getLogger()
logging.basicConfig(stream=sys.stdout, level=logging.DEBUG) logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)
zfs_repo_url = 'https://github.com/openzfs/zfs/'
man_sections = { man_sections = {
'1': 'User Commands', '1': 'User Commands',
@@ -99,8 +100,9 @@ def run(in_dir, out_dir):
os.makedirs(man_path, exist_ok=True) os.makedirs(man_path, exist_ok=True)
with open(os.path.join(man_path, 'index.rst'), "w") as f: with open(os.path.join(man_path, 'index.rst'), "w") as f:
f.write( f.write(
""" """.. THIS FILE IS AUTOGENERATED, DO NOT EDIT!
.. THIS FILE IS AUTOGENERATED, DO NOT EDIT!
:github_url: {zfs_repo_url}blob/master/man/
{name} {name}
{name_sub} {name_sub}
@@ -109,7 +111,8 @@ def run(in_dir, out_dir):
:glob: :glob:
*/index */index
""".format(name=man_section_name, """.format(zfs_repo_url=zfs_repo_url,
name=man_section_name,
name_sub="=" * len(man_section_name)) name_sub="=" * len(man_section_name))
) )
@@ -123,8 +126,9 @@ def run(in_dir, out_dir):
name=section_name, num=section_num) name=section_name, num=section_num)
with open(os.path.join(rst_dir, 'index.rst'), "w") as f: with open(os.path.join(rst_dir, 'index.rst'), "w") as f:
f.write( f.write(
""" """.. THIS FILE IS AUTOGENERATED, DO NOT EDIT!
.. THIS FILE IS AUTOGENERATED, DO NOT EDIT!
:github_url: {zfs_repo_url}blob/master/man/man{section_num}/
{name} {name}
{name_sub} {name_sub}
@@ -133,14 +137,17 @@ def run(in_dir, out_dir):
:glob: :glob:
* *
""".format(name=section_name_with_num, """.format(zfs_repo_url=zfs_repo_url,
name_sub="=" * len(section_name_with_num)) section_num=section_num,
name=section_name_with_num,
name_sub="=" * len(section_name_with_num),)
) )
for page in section_pages: for page in section_pages:
with open(os.path.join(rst_dir, page + '.rst'), "w") as f: with open(os.path.join(rst_dir, page + '.rst'), "w") as f:
f.write( f.write(
""" """.. THIS FILE IS AUTOGENERATED, DO NOT EDIT!
.. THIS FILE IS AUTOGENERATED, DO NOT EDIT!
:github_url: {zfs_repo_url}blob/master/man/man{section_num}/{name}
{name} {name}
{name_sub} {name_sub}
@@ -154,7 +161,8 @@ def run(in_dir, out_dir):
.. raw:: html .. raw:: html
</div> </div>
""".format(name=page, """.format(zfs_repo_url=zfs_repo_url,
name=page,
build_dir=build_dir, build_dir=build_dir,
section_num=section_num, section_num=section_num,
name_sub="=" * len(page)) name_sub="=" * len(page))