Publish documentation - Githubissues

retis-org / retis

Tracing packets in the Linux networking stack & friends

https://retis.readthedocs.io/en/stable/

100 stars 14 forks source link

Publish documentation #243

Closed amorenoz closed 1 year ago

amorenoz commented 1 year ago

Changes summary:

Use MkDocs to render the documentation
- Use readthedocs scheme
- Use readthedocs service (readthedocs.org) to build and publish the documentation. Result here
- Add an initial collector documentation.

Future work:

When we register the domain, we'll have to change one or two URLs
Add docs for the rest of the modules

An example with some fake releases can be seen here.

amorenoz commented 1 year ago

Continuation of #232 on a branch from this repo. Readthedocs.io has been configured to publish whatever is in this branch and maintainers can edit it.

amorenoz commented 1 year ago

IIUC we're generating documentation for readthedocs and for a specific GH page. Any reason for this? Couldn't we just use readthedocs?

This PR assumes we just use readthedocs. What GH page are you referring to?

The result (rendered from the PR branch) is here: https://retis.readthedocs.io/en/latest/ As soon as the PR gets merged we can start configuring what versions we want to build and publish.

atenart commented 1 year ago

IIUC we're generating documentation for readthedocs and for a specific GH page. Any reason for this? Couldn't we just use readthedocs?

This PR assumes we just use readthedocs. What GH page are you referring to?

The result (rendered from the PR branch) is here: https://retis.readthedocs.io/en/latest/ As soon as the PR gets merged we can start configuring what versions we want to build and publish.

I was probably a bit confused by the PR description which refers to https://amorenoz.github.io/retis; thanks for the clarification!

amorenoz commented 1 year ago

IIUC we're generating documentation for readthedocs and for a specific GH page. Any reason for this? Couldn't we just use readthedocs?

This PR assumes we just use readthedocs. What GH page are you referring to? The result (rendered from the PR branch) is here: https://retis.readthedocs.io/en/latest/ As soon as the PR gets merged we can start configuring what versions we want to build and publish.

I was probably a bit confused by the PR description which refers to https://amorenoz.github.io/retis; thanks for the clarification!

That's only a playground :-)