Sphinx vs mkdocs?
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation
Research direction
Start by reading the linked aind-software-docs standards page, then inspect this template's current Sphinx documentation setup and how its default is selected. Compare that setup with the stated MkDocs recommendation and record which standard the template should follow; the issue is done when the choice and resulting template direction are clearly documented.
Written by the indexing model from the issue text.
Description
aind-software-docs recommends using mkdocs, should the template conform to that instead of defaulting to sphinx docs?
- Dominant language
- Jinja
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
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.
More from AllenNeuralDynamics/python-templates
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
AllenNeuralDynamics/python-templates#10 · 1 assignee ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 38/100
AllenNeuralDynamics/python-templates#6 · 1 comment · 1 assignee ·
All issues in AllenNeuralDynamics/python-templates
Similar issues
-
content
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
GDQuest/learn-gdscript#1395 ·
-
rules
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
HttpClient
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
symfony/symfony-docs#23092 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
huggingface/sentence-transformers#4074 ·