sphinx - Githubissues

olga-erokhina commented 3 years ago

Hi, Have you tried working with sphinx? I totally missed this part during the classes

RobAnKo commented 3 years ago

Hi Olga, Yes, I worked with sphinx. In my functions I formatted the docstrings in a way that sphinx can automatically create docs from that. The main info is in here, last slide.

Since our folder structure is a little different, we have to tweak the commands. (Starting from our team13/ folder) I used the following commands

mkdir doc
cd doc
sphinx-quickstart
Now answer the prompts with 'y', 'mdp_analysis', 'Jing Sun, Olga Erokhina, Robin Koch', '1.0' and 'en'
Then open ./source/conf.py (for example using nano source/conf.py)
Modify the file as described, but use sys.path.insert(0, os.path.abspath('../../src/mdp_analysis')) instead of the command given in the slide
make html
sphinx-apidoc -o source/ ../src/mdp_analysis/
make html

Now in doc/build/index.html there should be a documentation where you can navigate around.

olga-erokhina commented 3 years ago

Thank you, it works!

brian811117 commented 3 years ago

I didn't do it actually. I think we can do it after we merge all the module together.

olga-erokhina / team13

sphinx #8