Question 1: Am I missing something, or are we not including the API docs in the "final docs"?
Question 2: If we're not including the API docs, do we want to?
Question 3: If we don't want to include the API docs, can we get rid of the build of them, as one way to get rid of the warnings? (Alternatively, keep the API docs, but fix the short underline warnings?)
From finding out #487, I then wondered where exactly the API docs were in the documentation in https://diamondlightsource.github.io/httomo/, and I couldn't find them.
They're definitely being built, it's in the docs build script: https://github.com/DiamondLightSource/httomo/blob/18c2e044c0a3c5e3dd831ab7139b1676ba5599bb/docs/sphinx-build.sh#L27-L28
but I don't see the built
api/
dir being included in theindex.rst
anywhere https://github.com/DiamondLightSource/httomo/blob/18c2e044c0a3c5e3dd831ab7139b1676ba5599bb/docs/source/index.rst?plain=1Question 1: Am I missing something, or are we not including the API docs in the "final docs"?
Question 2: If we're not including the API docs, do we want to?
Question 3: If we don't want to include the API docs, can we get rid of the build of them, as one way to get rid of the warnings? (Alternatively, keep the API docs, but fix the short underline warnings?)