ITADN

Documentation sanity checks: autodoc isn't setup (i think) but we link to api docs in the home page

#110Closedlwasser 创建于 2025-07-02
L
lwassercommented
The docs by default create a index page like this: ``` - Free software distributed under the MIT License. ```{toctree} :hidden: ./api/modules.rst ``` However, this assumes that the package has deps in place for the docs to build api docs. IT could be nice to add that as a feature for docs and pshinx. However, we should either set that up now or remove the API docs link for the time being, as it won't direct to an actual page (I think). Essentially, we need to test the docs setup. To make sure the elements in the output docs are working as expected. We do have a small module now, so we could build docs and API docs with autodoc if we want to. This decision might come down to timing. if we don't have time to implement autodoc then we should remove the api doc link from the docs landing page just for the workshop and leave this open as a TODO for later.
关闭于 2025-07-03 2 条评论