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

From makedocs to sphinx #241

Closed
4 tasks done
veenstrajelmer opened this issue Mar 28, 2024 · 0 comments · Fixed by #242
Closed
4 tasks done

From makedocs to sphinx #241

veenstrajelmer opened this issue Mar 28, 2024 · 0 comments · Fixed by #242

Comments

@veenstrajelmer
Copy link
Collaborator

veenstrajelmer commented Mar 28, 2024

This has documentation generation from docstrings via automodule, from only imported functions. So this is way less messy compared to makedocs.

Todo:

  • add sphinx docs
  • find a way to include the example notebook (also on github)
  • remove mkdocs dependencies, action and configfile
  • remove sphinx pull_request trigger in workflow file
@veenstrajelmer veenstrajelmer linked a pull request Mar 28, 2024 that will close this issue
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 a pull request may close this issue.

1 participant