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

Couple of improvements to documentation building and GitHub actions #243

Merged
merged 5 commits into from
Mar 25, 2022

Conversation

gipert
Copy link
Member

@gipert gipert commented Mar 25, 2022

No changes to files outside docs/ and .github/ folders, so I'm going to merge right now. This must be propagated to main and releases/* at the same time, I will cherry-pick and push these commits directly to those branches.

Related: #240

* See also legend-exp#240
* Git-ignore API auto-generated docs, run sphinx-apidoc automatically at
  build time
* Cleanup Makefile and conf.py
* add dotfile with python files/dir to ignore when building the API docs
* Update GitHub CI workflow with correct docs dependencies
* Allow for writing documentation in Markdown
* Enforce NumPy style for docstrings
@gipert gipert added the docs Package documentation label Mar 25, 2022
@gipert gipert merged commit 50454c8 into legend-exp:refactor Mar 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Package documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant