search

twoscoops / Creating-and-Distributing-Python-Packages

8 stars 0 forks source link

Documentation in readthedocs not include automatic docs of modules. #31

Closed cosmoscalibur closed 6 years ago

cosmoscalibur commented 6 years ago

Location within the Course

Description

Readthedocs is not building automated docs of modules because a .gitignore file is in docs directory excluding module documentation files.
You need remove that file and addig the new files to the repo.

pydanny commented 6 years ago

I do not have this problem. Audrey does not have this problem. Perhaps there is another reason why the docs are failing?

pydanny commented 6 years ago

Also, do not remove the .gitignore file, you modify it

cosmoscalibur commented 6 years ago

@pydanny and @audreyr , the content of the docs/.gitignore file is:

/<package-name>.rst
/<package-name>.*.rst
/modules.rst

Using this file, readthedocs not generate Module Index (and related pages).
In case of edit this file, what line is required to remove?

purplediane commented 6 years ago

I think this is related to https://github.com/audreyr/cookiecutter-pypackage/issues/342

pydanny commented 6 years ago

Resolved