jimbraun / XCDF

XCDF: eXplicitly Compacted Data Format. See documentation at Read the Docs:
https://xcdf.readthedocs.io/en/latest/
Other
14 stars 8 forks source link

Update documentation #95

Closed HealthyPear closed 1 year ago

HealthyPear commented 2 years ago

Requirements

Changes

I preferred to go for ReadTheDocs instead of GitHub Pages because it gives better support for PR and multi-version builds.

@jimbraun in order to use it, you should just create an account there using your GitHub one, so it can see this repository. I took the freedom to create for you the project there and make myself a maintainer: as soon as you have an account I should be able to see you and add you as a maintainer too.

You can get a peek at the generated Sphinx-based documentation by unpacking this compressed archive.

Hopefully, everything will go smoothly and at some point, something should appear at https://xcdf.readthedocs.io/en/latest/.

HealthyPear commented 1 year ago

I changed the name of the jobs, so you probably need to update your branch protection settings to update the required checks.

jimbraun commented 1 year ago

Thanks much. I agree with the changes and updated the branch protection settings.