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.

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

Set up documentation on readthedocs #45

Merged
merged 2 commits into from
Jul 25, 2024
Merged

Set up documentation on readthedocs #45

merged 2 commits into from
Jul 25, 2024

Conversation

stefsmeets
Copy link
Contributor

This PR sets up documentation on readthedocs. Once this PR is merged you can see the docs on https://fwl-janus.readthedocs.io

Test version for now: https://fwl-janus.readthedocs.io/en/rtd/

@stefsmeets
Copy link
Contributor Author

@timlichtenberg could you have a look at this and let me know what you think?

@timlichtenberg
Copy link
Member

timlichtenberg commented Jul 25, 2024

Will do, just waiting for the tests to be completed.

Copy link
Member

@timlichtenberg timlichtenberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, much nicer layout than the current PROTEUS docs. URL and layout should be homogenised in the PROTEUS docs once we get there.

@stefsmeets stefsmeets merged commit 9d44acd into master Jul 25, 2024
3 checks passed
@stefsmeets
Copy link
Contributor Author

Ah, I see proteus uses sphinx. I also prefer the layout of mkdocs and its much easier to work with imo. We can transfer proteus to mkdocs as well if you like.

@stefsmeets stefsmeets deleted the rtd branch July 25, 2024 12:42
lsoucasse pushed a commit that referenced this pull request Sep 24, 2024
lsoucasse pushed a commit that referenced this pull request Sep 24, 2024
* Set up readthedocs

* Fix site url
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants