search

seccomp / libseccomp

The main libseccomp repository
GNU Lesser General Public License v2.1
791 stars 170 forks source link

REF: setup libseccomp documentation on Read the Docs #195

Open pcmoore opened 4 years ago

pcmoore commented 4 years ago

It might be nice to look into hosting some of the libseccomp documentation on Read the Docs; at the very least a short into into the project and the info from the manpages.

However we do this, it should be automated. I do not want to have to maintain multiple sets of documentation; the Read the Docs documentation should pull from either the manpages or doxygen style comments in the code.

pcmoore commented 4 years ago

Related: #83.

oxr463 commented 4 years ago

You could also use GitHub Pages for this. Either way, let me know and I can knock it out pretty quick.

oxr463 commented 4 years ago

Read the Docs URL: https://libseccomp.readthedocs.io/en/latest/ Read the Docs Project URL: https://readthedocs.org/projects/libseccomp/

The project libseccomp doesn't have a valid webhook set up, commits won't trigger new builds for this project. See the project integrations for more information.

This needs to be owned by a GitHub Project maintainer.

Also, we can use Mkdocs for generating the docs using markdown, instead of reStructuredText and Sphinx.

oxr463 commented 4 years ago

See: https://readthedocs.org/projects/libseccomp/builds/10815405/

pcmoore commented 4 years ago

Hi @oxr463, I'm really happy to see you jumping in to help with the documentation - that is very good news! Right now we're trying to stay focused on getting v2.5.0 released, but I will definitely take you up your offer to help if you don't mind waiting a bit?

oxr463 commented 3 years ago

Hi @oxr463, I'm really happy to see you jumping in to help with the documentation - that is very good news! Right now we're trying to stay focused on getting v2.5.0 released, but I will definitely take you up your offer to help if you don't mind waiting a bit?

Hi there! Do you have any bandwidth for this now? See PR for latest updates.

pcmoore commented 7 months ago

In an effort to get v2.6.0 out sooner than later, I'm going to suggest we push this out to v2.7.0; if you have any concerns or objections please drop a comment.

oxr463 commented 7 months ago

@pcmoore yay! Looks like this might be getting priority judging from the milestone change. Let me know if you need any help getting this setup.

pcmoore commented 7 months ago

Hi @oxr463, unfortunately it is just the opposite, I'm suggesting we move this from the v2.6.0 release to the v2.7.0 release as no real progress has been made on this recently. However, the good news is that external documentation changes like this can be easily done outside major/minor release cycles.