Sphinx documentation for python #158
Conversation
ewanwm
requested review from
KSkwarczynski,
EdAtkin and
henry-wallace-phys
as code owners
github-actions
bot
added
Documentation
|
As somone who don't have much expiereince with spinx. This way within Or maybe something dumb and we need anohter repo pyMaCh3Web with spinx insutction etc. I like auto generated spinx that Henry did |
|
Yeah I'm also not much of an expert but have looked into this a bit. There are a few different tools for integrating doxygen and sphinx documentation. I think Breathe is one thats quite widely used. So I think it definitely should be possible and also I was planning to have them auto-generated too. I was planning to do this in a later pr though as I'm not sure how much will need to change or how much work it will be. |
Doc/sphinx/source/conf.py
Outdated
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information | ||
|
|
||
| project = 'pyMaCh3' | ||
| copyright = '2024, Ewan Miller' |
There was a problem hiding this comment.
Hyper nitpicky but I think MaCh3 has a copyright licence 😆
There was a problem hiding this comment.
lol my plan to steal MaCh3 has been foiled
…are/MaCh3 into feature_sphinx_documentation
README.md
Outdated
|
|
||
| ### Sphinx Documentation | ||
|
|
||
| The pyMACh3 module is documented using sphinx. Currently you need to build this documentation yourself if you want it (in future this will be automated). To do this, you will need to install Mach3 with its python extension as described above, then go to the [Doc/sphinx](Doc/sphinx) directory. Then you will need to install sphinx and the necessary extensions which can be done using | ||
|
|
||
| ``` | ||
| pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| then you can simply do | ||
|
|
||
| ``` | ||
| make html | ||
| ``` | ||
|
|
||
| and the documentation will be built in the build/html directory which you can open with whatever browser you like. | ||
|
|
There was a problem hiding this comment.
can you move this readme somehwere else? for example to Doc/spinx?
If you are planning to make this autgoerated then maye not add this to main readme?
I worry this will confuse people.
Pull request description:
Add in ability to generate sphinx documentation for the pyMaCh3 module
Changes or fixes:
added all necessary configs and some instructions on how to build to the readme
Examples:
Behold
Marvel at its beauty
