Closed bb515 closed 4 years ago
In order to upload documentation to a PyPI pacakage, you will first need to upload a test pacakage to PyPI.
The steps are:
In the branch feature/OpenCL_integrator_BB Generate docs
In the docs directory
cd ./docs
Directory for the built documentation
mkdir ./_build
Clean any existing documentation that has been built
make clean
This will put html file documentation in ./docs/_build
make html
Follow the steps here https://realpython.com/pypi-publish-python-package/
They should already be complete up to the step https://realpython.com/pypi-publish-python-package/#publishing-to-pypi
No luck with this, have decided to use readthedocs #76 as it seems much easier
Documentation should look something like, for example: https://pypi.org/project/dictionaries/
Following this tutorial, I get the error (listed below), and couldn't find any information on it on stack overflow etc. https://pythonhosted.org/an_example_pypi_project/buildanduploadsphinx.html more info about the package: https://pypi.org/project/Sphinx-PyPI-upload/0.2.1/
python setup.py upload_sphinx