scverse / scverse/scverse-misc
move generic docs stuff to `scverse-doc`?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 2
- Avg merge
- 11h 10m
- Merged PRs (30d)
- 13
Description
OK, so scverse-doc now almost exists. Should we move generic docs stuff there? E.g. some or all of what was added in #60 is not related to any runtime feature scverse-misc offers.
I wonder how we should handle it:
should scverse-doc depend on scverse-misc[sphinx] and load its extension? Then people could choose:
dependency-groups.docs = [ "scverse-doc" ]andextensions = ["scverse_doc"]gives them all scverse-doc features and all the scverse-misc features they activate in theirproject.dependenciesdependency-groups.docs = [ "scverse-doc" ]andextensions = ["scverse_doc.foo"]gives them only the subextensions they want (like scanpydoc)dependency-groups.docs = [ "scverse-misc" ]andextensions = ["scverse_misc.sphinx_ext"]give them just docs support for the runtime features, no additional docs features
but we’ve already deviated from that with #60 …
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the changes in #60 and reviewing the existing scverse-misc documentation support alongside scverse-doc. Compare the proposed dependency and extension-loading options, then define where generic documentation features should live and how users should activate them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100