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 using mkdocs #35

Merged
merged 2 commits into from
Jul 24, 2024
Merged

Set up documentation using mkdocs #35

merged 2 commits into from
Jul 24, 2024

Conversation

stefsmeets
Copy link
Contributor

@stefsmeets stefsmeets commented Jul 22, 2024

This PR sets up documentation using mkdocs. You can build the documentation for yourself like this:

pip install -e .[docs]
mkdocs serve

Once this is merged I'm happy to set up documentation on readthedocs under https://fwljanus.readthedocs.io

Closes #29

@timlichtenberg
Copy link
Collaborator

So my only point why hesitating with this is the consideration of whether we want to have individual docs for all sub-modules, or whether they should all be incorporated into proteus documentation. I cannot exactly remember anymore whether we agreed this was the best solution or not, we discussed this at one of the last meetings.

@stefsmeets
Copy link
Contributor Author

This can be solved afterwards using subprojects: https://docs.readthedocs.io/en/stable/subprojects.html

@timlichtenberg
Copy link
Collaborator

Awesome, this sounds good to me then!

@timlichtenberg timlichtenberg self-requested a review July 24, 2024 15:05
@stefsmeets stefsmeets merged commit 5b4c9bf into master Jul 24, 2024
6 checks passed
@stefsmeets stefsmeets deleted the mkdocs branch July 24, 2024 15:14
@stefsmeets
Copy link
Contributor Author

If I have time tomorrow I will set this up on readthedocs.

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.

Create Documentation
2 participants