Added Sphinx Documentation #5
Conversation
- added docstrings to functions to get picked up by the sphinx auto-documentation - added logger
- files located in build/ and source/ - main file is index.rst - documentation .rst file made from docstrings and comments - images are located in source/_images
|
The sphinx build step is failing because you don't have the expected pyproject.toml file in this branch. Quickest fix is to merge the poetry branch into this branch, once you're happy you've got the poetry stuff sorted. |
|
Also you're best to delete the |
There was a problem hiding this comment.
Is this a picture you found somewhere or one you screenshotted yourself? Would be nice to get the CEDA flight finder branding included in the picture!
source/conf.py
Outdated
| sys.path.insert(0, os.path.abspath('../flightpipe/updaters')) | ||
|
|
||
| project = 'Flight-Finder' | ||
| author = 'Daniel Westwood' |
There was a problem hiding this comment.
Check sphinx docs for how to add multiple authors, so it's both of us. Also the same for the Poetry author part!
source/core/doc.rst
Outdated
| ============= | ||
| Documentation | ||
| ============= | ||
|
|
There was a problem hiding this comment.
Would be nice to add a couple of lines in this file about the purpose of the flight pipeline and flight finder in general
source/index.rst
Outdated
|
|
||
| Flight-pipeline documentation | ||
| ============================= | ||
|
|
There was a problem hiding this comment.
Similar description to the top of docs. Include when the package was created (March 2023), what it's used for, maybe link to flight finder UI. Then a paragraph on your contributions!
- added description - changed picture on first page of documentation
- added entrypoint in pyproject.toml under [project.scripts] section for running the flight_update
|
Hi Ioana, looks like the next step for these three pull requests is to merge them all into one request, and deal with any merge conflicts as there are some areas that might have opposing changes. Everything you've done for these three aims looks good so far. I'll just add a couple of comments here:
I'll message you directly for a meeting early next week to give time for any final changes, and for you to write a short handover document with your changes to Wendy and some basic instructions for how to use the pipeline (might just be directing her to the brand new documentation!) |
No description provided.