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

switch to cookiecutter-scverse template #372

Closed
21 of 24 tasks
grst opened this issue Oct 22, 2022 · 0 comments
Closed
21 of 24 tasks

switch to cookiecutter-scverse template #372

grst opened this issue Oct 22, 2022 · 0 comments
Projects
scirpy-dev

Comments

@grst
Copy link
Collaborator

grst commented Oct 22, 2022 •
edited
Loading

https://github.com/scverse/cookiecutter-scverse

  • update REAMDE (rst -> md)
  • move everything to src
  • update pyproject.toml
  • copy changelog from github releases to CHANGELOG.md
  • re-add api docs for DataHandler
  • include dev docs from template
  • switch to dark logo
  • tempoarily use rendered ipynb tutorials for documentation
  • rename master to main
  • add test to run tutorials as part of CI
  • fix CI and use CI scripts from template
  • go through entire docs and fix misrendered elements
  • pre-commit run --all-files
  • add cruft.json
  • cruft update
  • sphinx fail on warning
  • re-enable branch protections
  • reduce figure size in tutorial / reduce font size in pandas tables -> fix upstream in cookiecutter template. issues created.
  • in a few API docs, bulleted lists are incorrectly rendered as quotation (e.g. ir_query_annotate) not important enough to care
  • fix existing ruff lint (pre-commit run --all-files)
  • switch docs to readthedocs

follow-up

  • update links to point to readthedocs
  • forwarding to readthedocs
  • add page linking to old versions of documentation. They must keep being hosted on github pages.
@grst grst created this issue from a note in scirpy-dev (ToDo) Oct 22, 2022
@grst grst mentioned this issue Oct 27, 2022
Closed
7 tasks
@grst grst moved this from ToDo to In progress in scirpy-dev Apr 13, 2023
@grst grst mentioned this issue Apr 25, 2023
Merged
@grst grst closed this as completed Jun 9, 2023
scirpy-dev automation moved this from In progress to Done Jun 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
scirpy-dev
Archived in project
scirpy-dev
  
Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@grst