search

eblur / pyxsis

Python code for manipulating high resolution X-ray spectra
GNU Lesser General Public License v3.0
9 stars 1 forks source link

Autodoc is not working on functions #25

Closed eblur closed 3 years ago

eblur commented 3 years ago

I just noticed that the ReadTheDocs pages aren't showing the autodoc results for my library functions. For example: https://pyxsis.readthedocs.io/en/latest/plotting.html

Need to de-bug / test the autodoc tool for function docstrings.

eblur commented 3 years ago

And I can't reproduce this error locally on my machine, so it likely has something to do with my ReadTheDocs configuration I guess.

eblur commented 3 years ago

I had to add a command to the .readthedocs.yaml file to use "setuptools", which runs the setup.py script in the home directory.

python:
   version: 3.7
   install:
   - requirements: docs/requirements.txt
   - method: setuptools
     path: .