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

Jump to bottom

doc: convert to markdown and publish to Read the Docs #230

Closed
wants to merge 7 commits into from
Closed

doc: convert to markdown and publish to Read the Docs #230

wants to merge 7 commits into from

Conversation

oxr463
Copy link

@oxr463 oxr463 commented Apr 11, 2020 •
edited
Loading

@coveralls
Copy link

Coverage Status

Coverage remained the same at 92.701% when pulling 261c13b on oxr463:feature_markdown into c561096 on seccomp:master.

@oxr463 oxr463 force-pushed the feature_markdown branch 5 times, most recently from 23efcfc to 58a0609 Compare April 11, 2020 21:06
@pcmoore pcmoore linked an issue Apr 13, 2020 that may be closed by this pull request
REF: setup libseccomp documentation on Read the Docs #195
Open
Base automatically changed from master to main January 22, 2021 21:36
@oxr463 oxr463 changed the title WIP: Markdown documentation for Read the Docs Markdown documentation for Read the Docs May 24, 2021
@oxr463
Convert man pages to markdown
2823029 
Signed-off-by: Lucas Ramage <[email protected]>
@oxr463
Add mkdocs configuration
91e35d6 
Signed-off-by: Lucas Ramage <[email protected]>
@oxr463 oxr463 force-pushed the feature_markdown branch 2 times, most recently from e8b3c65 to 70a6122 Compare May 24, 2021 20:25
@oxr463
Copy link
Author

oxr463 commented May 24, 2021

@pcmoore please review.

@oxr463 oxr463 changed the title Markdown documentation for Read the Docs doc: convert to markdown and publish to Read the Docs Jun 6, 2021
@drakenclimber
Copy link
Member

FYI - The make check-build command failed with the following error

make[2]: *** No rule to make target 'man/man1/scmp_sys_resolver.1', needed by 'all-am'.  Stop.
Makefile:515: recipe for target 'all-recursive' failed
make[1]: *** [all-recursive] Error 1
Makefile:424: recipe for target 'all' failed
make: *** [all] Error 2
The command "make check-build" exited with 2.

@oxr463
Copy link
Author

oxr463 commented Jul 20, 2021

FYI - The make check-build command failed with the following error

make[2]: *** No rule to make target 'man/man1/scmp_sys_resolver.1', needed by 'all-am'.  Stop.
Makefile:515: recipe for target 'all-recursive' failed
make[1]: *** [all-recursive] Error 1
Makefile:424: recipe for target 'all' failed
make: *** [all] Error 2
The command "make check-build" exited with 2.

Looks like I need to use pandoc to convert the markdown files back into man pages in the Makefile:

pandoc --standalone --to man man/man1/scmp_sys_resolver.1.md -o man/man1/scmp_sys_resolver.1

@oxr463 oxr463 closed this Feb 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
enhancement priority/low
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

REF: setup libseccomp documentation on Read the Docs RFE: consider generating the man pages from Markdown
4 participants
@oxr463 @coveralls @drakenclimber @pcmoore