Unnecessary `docs/index.html` file?
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Domain
- documentation
Research direction
Inspect docs/index.html alongside docs/sphinx-build.sh and .github/workflows/httomo_docs.yml, especially the linked Sphinx build commands. Check whether the tracked file is referenced or required anywhere, then run the documentation build and confirm the generated docs still contain the homepage without docs/index.html.
Written by the indexing model from the issue text.
Description
I'm fairly sure that the index.html file that serves as the homepage for the docs is generated automatically by sphinx and placed in a dir docs/build/:
- this is what happens locally when running the
sphinx-build.shcommand: https://github.com/DiamondLightSource/httomo/blob/c46fb1e359accab2157f0ad53647dd9fc85fef0d/docs/sphinx-build.sh#L22 - and the CI does a similar command to put the output in
docs/build/https://github.com/DiamondLightSource/httomo/blob/c46fb1e359accab2157f0ad53647dd9fc85fef0d/.github/workflows/httomo_docs.yml#L43-L44
so I don't think the docs/index.html file is actually used for anything?
- Dominant language
- Python
- Stars
- 10
- Forks
- 5
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 1
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 DiamondLightSource/httomo
-
ci
Difficulty 1/5 Under an hour Newbie friendliness 88/100
DiamondLightSource/httomo#714 ·
-
framework minor
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
DiamondLightSource/httomo#699 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
DiamondLightSource/httomo#609 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
DiamondLightSource/httomo#607 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
DiamondLightSource/httomo#585 ·
All issues in DiamondLightSource/httomo
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100