Skip to content

Commit

Permalink
docs: Add header information on command line interface page
Browse files Browse the repository at this point in the history
  • Loading branch information
Sieboldianus committed Apr 10, 2022
1 parent 43ddea3 commit 9602c47
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/argparse/argparse_after_doc.py
Expand Up @@ -27,6 +27,16 @@ def format_markdown():
newline = newline.replace('\n*\n','\n* ')
newlines.append(newline)
all_lines = ''.join(newlines)
# insert header lines

all_lines = all_lines.replace(
'Arguments and Usage\n', 'Arguments and Usage\nThis page is generated from the source code '
'([config.py](https://gitlab.vgiscience.de/lbsn/lbsntransform/-/blob/master/lbsntransform/config/config.py)) and '
'provides an overview of lbsntransform command line arguments.\n\n')
all_lines = all_lines.replace('Quick reference table\n', 'Quick reference table\n'
'The quick reference table contains truncated short summaries of descriptions. Jump to individual arguments '
'in the navigation submenu on the left side.\n\n'
)
# fix code blocks from argdown
# first remove all line breaks
# and add valid ones afterwards
Expand Down

0 comments on commit 9602c47

Please sign in to comment.