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

Add API Reference building to docs #25

Merged
merged 10 commits into from
Mar 28, 2024
Merged

Conversation

raar1
Copy link
Contributor

@raar1 raar1 commented Mar 27, 2024

Fixes #7

This adds (automatic) API Reference generation to the docs, as well as a developer docs page etc for showing how to add extra pages to the documentation. Also configures mkdocs correctly, removes unused dependencies, updates developer README and changes icon to use the mibirem logo.

@raar1 raar1 requested a review from JaroCamphuijsen March 27, 2024 16:14
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

Copy link
Contributor

@JaroCamphuijsen JaroCamphuijsen left a comment

Choose a reason for hiding this comment

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

This looks great @raar1. Thanks for finishing this today. Go ahead and merge it!

@raar1 raar1 merged commit 77810fa into main Mar 28, 2024
8 checks passed
@raar1 raar1 deleted the exorcize_sphinx_and_readthedocs branch March 28, 2024 09:03
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.

Next step: Read the Docs
2 participants