DiamondLightSource / DiamondLightSource/httomo

Unnecessary `docs/index.html` file?

Open
#697 0 comments 0 reactions 0 assignees View on GitHub
documentation question
Dominant language
Python
Stars
10
Forks
5
Avg merge
5d 17h
Merged PRs (30d)
1

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.sh` command: 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?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.