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

Online documentation build can be enabled on ReadTheDocs #97

Closed HealthyPear closed 1 year ago

HealthyPear commented 1 year ago

After #95 the new documentation can be built online by the free service of ReadTheDocs.

In order to do this, the repository needs to be connected via a webhook to the service.

See https://docs.readthedocs.io/en/stable/intro/import-guide.html.

The project is already setup here https://readthedocs.org/projects/xcdf/

and when the repo is connected the documentation should appear here https://xcdf.readthedocs.io/en/latest/

HealthyPear commented 1 year ago

I activated my fork of this repository on ReadTheDocs, since for that repo I have all writing permissions.

I managed to build successfully the documentation online from the branch of #98 and you can see the result here: https://xcdf-my-fork.readthedocs.io/en/fix-rtd_docs_build/

HealthyPear commented 1 year ago

Once the official documentation page is online we can than add its link to the "About" section on the right sidebar of the main repository page and in the README.

HealthyPear commented 1 year ago

The documentation from the master branch (from my fork, so not the official one) can be seen here https://xcdf-my-fork.readthedocs.io/en/latest/

HealthyPear commented 1 year ago

Hi @jimbraun , I guess you enabled it?

I can now see the successful build also from the original readthedocs project https://readthedocs.org/projects/xcdf/

can you access it?

If yes I would add this link to the About" section on the right sidebar of the main repository page and in the README (the latter I can do myself via a PR, but the first can only be done by you).

jimbraun commented 1 year ago

Done. Thanks!

HealthyPear commented 1 year ago

@jimbraun sorry I gave you an incorrect URL, the correct one is this

https://xcdf.readthedocs.io/en/latest/

HealthyPear commented 1 year ago

All seems set now, so I'll close this issue.

(we should also close #87 )

HealthyPear commented 1 year ago

and maybe also #13 ?