Skip to content

Improved online documentation#1498

Merged
VGPReys merged 8 commits intomainfrom
improved-documentation
Apr 8, 2026
Merged

Improved online documentation#1498
VGPReys merged 8 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
@VGPReys
Copy link
Copy Markdown
Contributor Author

VGPReys commented Apr 8, 2026

comments have been addressed :)

@VGPReys VGPReys requested a review from AnnaKravchenko April 8, 2026 12:00
@AnnaKravchenko
Copy link
Copy Markdown
Contributor

This close to approved!
The “_” is still misplaced. It have to be after the “`”

Like so "module>`_”. Currently links are still not clikable.

@VGPReys
Copy link
Copy Markdown
Contributor Author

VGPReys commented Apr 8, 2026

This close to approved! The “_” is still misplaced. It have to be after the “`”

Like so "module>`_”. Currently links are still not clikable.

Good point !

Copy link
Copy Markdown
Contributor

@AnnaKravchenko AnnaKravchenko left a comment

Choose a reason for hiding this comment

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

Yes, it is perfect now!

@VGPReys VGPReys merged commit 0531f00 into main Apr 8, 2026
10 checks passed
@VGPReys VGPReys deleted the improved-documentation branch April 8, 2026 14:23
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