search

stfc / HartreeParticleDSL

MIT License
1 stars 1 forks source link

Use sphinx to generate documentation from python files #9

Closed LonelyCat124 closed 2 years ago

LonelyCat124 commented 3 years ago

Some documentation can be created automatically from the pydoc documentation. This needs to be done inside any documentation.

sreyan-ghosh commented 3 years ago

Hello, I would like to work on this, please. Could you assign it to me? This will be a part of my Hacktoberfest 2021 submission.

Also, I am generating the documentation for the src/HartreeParticleDSL directory only since I'm not very sure how to implement source streams from multiple directories. I hope that is alright.

sreyan-ghosh commented 3 years ago

I am not able to figure it out, I am facing problems with the source directory and the project structure. Need help.

LonelyCat124 commented 3 years ago

What issues are you seeing? All of the project's code is in src/HartreeParticleDSL with the test folder containing the pytest suite. Things outside of the src can definitely be adjusted if needs be - they were really just a minimal setup to get the project installed with pip and allow development.

sreyan-ghosh commented 3 years ago

So, I am not very familiar with sphinx but I looked at a couple of videos on youtube and read through the docs. The problem I am facing is, I am not able to figure out what to add in the index.rst and the conf.py files. I have tried pointing it to the src/HartreeParticleDSL directory and also to the root, and also did a os.walk() to individually add the dirs, but that too gave a similar error. I cross-referenced the error on Google and got the idea that it refers to an incorrect source dir pointing problem. I'll share snapshots of the error soon.

This is the video I referred to.