Skip to content

Commit

Permalink
docs: Restructure manual pages in preparation for web publishing
Browse files Browse the repository at this point in the history
  • Loading branch information
rdmark committed Jan 25, 2025
1 parent 4589d88 commit 7e024da
Show file tree
Hide file tree
Showing 62 changed files with 2,586 additions and 1,132 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ include/atalk/afp_dtrace.h

# Temporary build files
build/**
*.pot
2 changes: 1 addition & 1 deletion doc/generate_compile_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

linebreak_escape_pattern = r'\\\n\s+'

output_file = "./manual/compile.md"
output_file = "./manual/Compilation.md"

with open('../.github/workflows/build.yml', 'r') as file:
workflow = yaml.safe_load(file)
Expand Down
16 changes: 1 addition & 15 deletions doc/manpages/man1/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -65,20 +65,6 @@ endif

if get_option('with-website')
foreach page : manfiles
custom_target(
'manual_' + page,
input: page + '.1.md',
output: page + '.1.html',
command: [
cmarkgfm,
'--smart',
'--extension', 'table',
'--to', 'html',
'@INPUT@',
],
capture: true,
install: true,
install_dir: manual_install_path,
)
install_data(page + '.1.md', rename: page + '.md', install_dir: manual_install_path + '/en')
endforeach
endif
16 changes: 1 addition & 15 deletions doc/manpages/man3/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,6 @@ endforeach

if get_option('with-website')
foreach page : manfiles
custom_target(
'manual_' + page,
input: page + '.3.md',
output: page + '.3.html',
command: [
cmarkgfm,
'--smart',
'--extension', 'table',
'--to', 'html',
'@INPUT@',
],
capture: true,
install: true,
install_dir: manual_install_path,
)
install_data(page + '.3.md', rename: page + '.md', install_dir: manual_install_path + '/en')
endforeach
endif
16 changes: 1 addition & 15 deletions doc/manpages/man4/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,5 @@ custom_target(
)

if get_option('with-website')
custom_target(
'manual_' + page,
input: manfile + '.4.md',
output: manfile + '.4.html',
command: [
cmarkgfm,
'--smart',
'--extension', 'table',
'--to', 'html',
'@INPUT@',
],
capture: true,
install: true,
install_dir: manual_install_path,
)
install_data(manfile + '.4.md', rename: manfile + '.md', install_dir: manual_install_path + '/en')
endif
16 changes: 1 addition & 15 deletions doc/manpages/man5/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,6 @@ install_data('macipgw.conf.5', install_dir: mandir / 'man5')

if get_option('with-website')
foreach page : manfiles
custom_target(
'manual_' + page,
input: page + '.5.md',
output: page + '.5.html',
command: [
cmarkgfm,
'--smart',
'--extension', 'table',
'--to', 'html',
'@INPUT@',
],
capture: true,
install: true,
install_dir: manual_install_path,
)
install_data(page + '.5.md', rename: page + '.md', install_dir: manual_install_path + '/en')
endforeach
endif
16 changes: 1 addition & 15 deletions doc/manpages/man8/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,6 @@ endforeach

if get_option('with-website')
foreach page : manfiles
custom_target(
'manual_' + page,
input: page + '.8.md',
output: page + '.8.html',
command: [
cmarkgfm,
'--smart',
'--extension', 'table',
'--to', 'html',
'@INPUT@',
],
capture: true,
install: true,
install_dir: manual_install_path,
)
install_data(page + '.8.md', rename: page + '.md', install_dir: manual_install_path + '/en')
endforeach
endif
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
57 changes: 57 additions & 0 deletions doc/manual/_Sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
[[en]] | [[ja]]

Manual

* [[Installation]]
* [[Configuration]]
* [[AppleTalk]]
* [[Upgrade]]

User Tools

* [[ad]]
* [[addump]]
* [[aecho]]
* [[afpldaptest]]
* [[afppasswd]]
* [[afpstats]]
* [[afptest]]
* [[asip-status]]
* [[dbd]]
* [[getzones]]
* [[macusers]]
* [[nbp]]
* [[pap]]

Configuration Files

* [[afp_signature.conf]]
* [[afp_voluuid.conf]]
* [[afp.conf]]
* [[atalkd.conf]]
* [[extmap.conf]]
* [[papd.conf]]

Daemons and Admin Tools

* [[a2boot]]
* [[afpd]]
* [[atalkd]]
* [[cnid_dbd]]
* [[cnid_metad]]
* [[macipgw]]
* [[netatalk]]
* [[papd]]
* [[papstatus]]
* [[timelord]]

Developer References

* [[atalk_aton]]
* [[nbp_name]]
* [[atalk]]

Appendices

* [[Compilation]]
* [[License]]
File renamed without changes.
55 changes: 31 additions & 24 deletions doc/manual/meson.build
Original file line number Diff line number Diff line change
@@ -1,37 +1,44 @@
manual_pages = [
'configuration',
'install',
'intro',
'upgrade',
'Configuration',
'Installation',
'Upgrade',
]

if have_appletalk
manual_pages += [
'appletalk',
'AppleTalk',
]
endif

if get_option('with-website')
manual_pages += [
'compile',
'gpl-2.0',
'_Sidebar',
'Compilation',
'index',
'License',
]
endif

foreach page : manual_pages
custom_target(
'manual_' + page,
input: page + '.md',
output: page + '.html',
command: [
cmarkgfm,
'--smart',
'--extension', 'table',
'--to', 'html',
'@INPUT@',
],
capture: true,
install: true,
install_dir: manual_install_path,
)
endforeach
if get_option('with-website')
foreach page : manual_pages
install_data(page + '.md', install_dir: manual_install_path + '/en')
endforeach
else
foreach page : manual_pages
custom_target(
'manual_' + page,
input: page + '.md',
output: page + '.html',
command: [
cmarkgfm,
'--smart',
'--extension', 'table',
'--to', 'html',
'@INPUT@',
],
capture: true,
install: true,
install_dir: manual_install_path,
)
endforeach
endif
1 change: 0 additions & 1 deletion doc/po/.gitignore

This file was deleted.

Loading

0 comments on commit 7e024da

Please sign in to comment.