populationsim
populationsim copied to clipboard
Documentation: Add Sphinx deps to pyproject.toml; update Makefile to use pyproject.toml
-
Add Sphinx deps to pyproject.toml: This may not be a concern since you plan to have a built version of the documentation users can access online via a link. But the pyproject.toml doesn’t include sphinx/other packages required to build the documentation from the *.rst’s. I had to do a bit of work within the project environment to successfully build a local version of the documentation for review. Other notes about building the documentation:
-
Update project structure: It does not appear that the software.rst has been updated based on the revised structure of the populationsim folder. For example, its reference to the assign component is populationsim.assign (e.g. it is found in the folder populationsim) but this is no longer the case. Assign now resides in a sub-folder called ‘core’. So, the reference in software.rst should be populationsim.core.assign. The same holds for any software component that has been relocated in the updated populationsim folder structure.
-
Update makefile to use pyproject.toml: If using MAKEFILE to generate documentation, there is code included that expects to find a setup.py file in the root directory. However, the setup.py file was replaced with a pyproject.toml file as part of this pull request. The reference to setup.py must be replaced with a reference to pyproject.toml for the MAKEFILE to run. This is not an issue with the make.bat.