Skip to content

Improved online documentation#1498

Open
VGPReys wants to merge 3 commits intomainfrom
improved-documentation
Open

Improved online documentation#1498
VGPReys wants to merge 3 commits intomainfrom
improved-documentation

Conversation

@VGPReys
Copy link
Copy Markdown
Contributor

@VGPReys VGPReys commented Apr 6, 2026

Summary of the Pull Request

This PR tries to improve the online documentation by adding links to the haddock3 user manual in each module docstrings.

Therefore, it now should be easier to navigate between the developer documentation and the user manual one, hopefully providing a better understanding of each module.

@VGPReys VGPReys self-assigned this Apr 6, 2026
@VGPReys VGPReys added the documentation Improve docs label Apr 6, 2026
@AnnaKravchenko
Copy link
Copy Markdown
Contributor

Great idea!
Now I am struggling to understand how these two, dev documenation and modules’ docstrings, are connected.
Will ask you to show me in person tomorrow.

@VGPReys VGPReys enabled auto-merge April 7, 2026 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improve docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants