-
Notifications
You must be signed in to change notification settings - Fork 23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update doc creation, Fix content #1854
Conversation
vvmruder
commented
Oct 26, 2023
•
edited
Loading
edited
- rebase on underlying libs
- fix sphinx
- fix autodoc
- fixes Clean Readme and Doc #1257
- fixes Use makefile2graph to visualze Makefile target dependencies #1240
- fixes Documentation: fix warnings #1675
Codecov Report
@@ Coverage Diff @@
## master #1854 +/- ##
=======================================
Coverage 77.73% 77.73%
=======================================
Files 127 127
Lines 5268 5268
=======================================
Hits 4095 4095
Misses 1173 1173
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
0843952
to
bd550a8
Compare
@voisardf & @michmuel & @julianhafner: The DOC refactoring is done. Please feel free to test and comment. You can do the doc build with: docker compose run --rm oereb-server make doc-html Files are created here (open it in browser should work unless some security settings are blocking it):
This PR is purely structure refactoring and preparation of further doc work. The doc structure now reflects the more modular python contrib approach of pyramid_oereb. One PR which will be rebased and merged ontop of this one is #1466 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me so far 👍 The structure refactoring is good for further doc work.
To me some of the newly added makefile2graph graphs are more confusing than helpful, but that might be personal preference.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, thanks.
Just one question regarding some of the files like
- doc/source/contrib/data_sources/standard/index.rst.mako and
- doc/source/contrib/data_sources/standard/index.rst
is there a reason for keeping both, the index.rst.mako and the index.rst which should normally be generated based on the mako file? What did I miss there?
remove leading whitespace to ensure correct HTML formatting
5eb477f
to
3838005
Compare
😬 Good catch 😆 I removed it. |