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.

Sign up for GitHub

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

Create manpages #36

Merged
merged 11 commits into from
Nov 5, 2023
Merged

Create manpages #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
cd43e18
Adds custom hugo environment for manpage build
eldarnash Oct 22, 2023
861fa16
Adds original xslt for xhtml to man conversion
eldarnash Oct 22, 2023
8f217a3
Use <meta section> value if available
eldarnash Oct 22, 2023
0794326
Adds script that generates man pages from their html version
eldarnash Oct 22, 2023
56b5623
Make it possible to autogenerate the driver lists for the manpages
eldarnash Oct 23, 2023
ba42cc6
Update source and destination metadata
eldarnash Oct 23, 2023
96ebb84
Use automatic source and driver lists
eldarnash Oct 23, 2023
213f596
Adds a list of links to the end of the manpages
eldarnash Oct 23, 2023
ed38b2c
Path updates
eldarnash Nov 5, 2023
0280380
Adds generating manpages to staging workflow
eldarnash Nov 5, 2023
fecc3dc
Merge branch 'main' into create-manpages
eldarnash Nov 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/workflows/staging.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,15 @@ jobs:
- name: Build
run: hugo --environment staging --baseURL ${{ steps.pages.outputs.base_url }}/

# Build hugo output with manpages environment, run scripts, copy output manpages to public so it gets uploaded
- name: Build manpage environment
run: hugo --environment manpage --baseURL ${{ steps.pages.outputs.base_url }}/ --destination manpages
- name: Convert manpages
run: |
sudo apt-get install -y xsltproc
python3 scripts/create-man-from-html.py
mv manpages/syslog-ng-manpages/ public/

- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
Expand Down
6 changes: 3 additions & 3 deletions scripts/create-man-from-html.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ def convert_html_to_man(rawhtml, original_file, output_dir):
manfile.close()

## Delete html file
# subprocess.run(["rm", output_html_file])
subprocess.run(["rm", output_html_file])

global errors, unix_name, section
errors = []
Expand All @@ -117,8 +117,8 @@ def convert_html_to_man(rawhtml, original_file, output_dir):
# Process manpages files
print("Processing manpages files")

input_manpage_dir = "public/app-man-syslog-ng"
output_manpage_dir = "public/syslog-ng-manpages"
input_manpage_dir = "manpages/app-man-syslog-ng"
output_manpage_dir = "manpages/syslog-ng-manpages"

for root, dirs, files in os.walk(input_manpage_dir):
for file in files:
Expand Down