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.

Sign up for GitHub

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

Jump to bottom

Project documentation #240

Open
11 of 12 tasks
gipert opened this issue Mar 24, 2022 · 0 comments
Open
11 of 12 tasks

Project documentation #240

gipert opened this issue Mar 24, 2022 · 0 comments
Assignees
@gipert
Labels
docs Package documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@gipert
Copy link
Member

gipert commented Mar 24, 2022 •
edited
Loading

I'm posting a to-do list here. I'll keep it up-to-date. Good reference: https://scikit-hep.org/developer
@gipert gipert added help wanted Extra attention is needed good first issue Good for newcomers docs Package documentation labels Mar 24, 2022
@gipert gipert self-assigned this Mar 24, 2022
gipert added a commit to gipert/pygama that referenced this issue Mar 25, 2022
@gipert
[docs] [ci] various improvements to docs building mechanism
8fefe4e 
* 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 added a commit to gipert/pygama that referenced this issue Mar 25, 2022
@gipert
[docs] [ci] various improvements to docs building mechanism
393a2a4 
* 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 added a commit to gipert/pygama that referenced this issue Mar 25, 2022
@gipert
[docs] [ci] various improvements to docs building mechanism
089dad6 
* 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
This was referenced Mar 25, 2022
Merged
Merged
@gipert gipert pinned this issue Apr 6, 2022
@gipert gipert unpinned this issue Dec 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gipert gipert

Labels
docs Package documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gipert