Sphinx Documentation not working

[HL232]

I wrote all my Docstrings, and I tried to use the Sphinx Quickstart tool in Pycharm to generate documentation. I think I followed the procedure on how to generate documentation but it's not working, and I don't understand how the Sphinx files work.

[suyashkumar]

Hi @HL232 -- did you follow the instructions here? The *.rst files will be generated automatically by calling sphinx-apidoc -o docs . after getting everything setup. Then, you will call make html to build HTML versions of the documentation from the root level of your project to generate html docs.

If the above does not work, can you specifically mention what is not working (e.g. html docs are not being created) or what errors your are getting?

[HL232]

Thanks @suyashkumar I think it might be working now. So basically, my auto-generated documentation is in the file path _build/html/index.html. If I open that locally, then I can see all the documentation formatted nicely.

Then I pushed all the sphinx generated stuff to Github, and downloaded the repo try to see what you will see while grading. If I open the _build/html/index.html from the downloaded repo, the documentation is still there, but the pretty formatting is gone. I don't know which Sphinx auto-generated files are important to include, so I kept the docs, _build, conf.py, make, and makefile files in my repo. Am I supposed to include these files in the repo? Which files/folders are vital to keep in order to see the auto-generated documentation, and which ones aren't supposed to be pushed to Git?