Skip to content
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

Merged
merged 8 commits into from
Nov 3, 2023
Merged

Update doc creation, Fix content #1854

merged 8 commits into from
Nov 3, 2023

Conversation

vvmruder
Copy link
Collaborator

@vvmruder vvmruder commented Oct 26, 2023

@vvmruder vvmruder requested review from michmuel and voisardf October 26, 2023 12:25
@vvmruder vvmruder changed the title Update doc creation, Fix content [WIP] Update doc creation, Fix content Oct 26, 2023
@codecov
Copy link

codecov bot commented Oct 26, 2023

Codecov Report

Merging #1854 (9d5b3e0) into master (348b15c) will not change coverage.
Report is 1 commits behind head on master.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1854   +/-   ##
=======================================
  Coverage   77.73%   77.73%           
=======================================
  Files         127      127           
  Lines        5268     5268           
=======================================
  Hits         4095     4095           
  Misses       1173     1173           
Flag Coverage Δ
unittests 77.73% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
...b/contrib/data_sources/standard/models/__init__.py 100.00% <ø> (ø)
...oereb/contrib/data_sources/standard/models/main.py 100.00% <ø> (ø)
...contrib/print_proxy/mapfish_print/mapfish_print.py 86.14% <ø> (ø)
pyramid_oereb/core/readers/data_integration.py 0.00% <ø> (ø)
pyramid_oereb/core/readers/law_status.py 100.00% <ø> (ø)
pyramid_oereb/core/readers/real_estate_type.py 100.00% <ø> (ø)
pyramid_oereb/core/records/view_service.py 82.90% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@vvmruder vvmruder force-pushed the update_installation_docs branch from 0843952 to bd550a8 Compare October 30, 2023 12:44
@vvmruder vvmruder changed the title [WIP] Update doc creation, Fix content Update doc creation, Fix content Oct 30, 2023
@vvmruder vvmruder requested a review from julianhafner October 30, 2023 12:53
@vvmruder
Copy link
Collaborator Author

vvmruder commented Oct 30, 2023

@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):

doc/build/html/index.html

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

Copy link
Contributor

@julianhafner julianhafner left a 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.

doc/source/makefile.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@voisardf voisardf left a 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?

@vvmruder vvmruder force-pushed the update_installation_docs branch from 5eb477f to 3838005 Compare November 3, 2023 08:42
@vvmruder
Copy link
Collaborator Author

vvmruder commented Nov 3, 2023

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?

😬 Good catch 😆

I removed it.

@vvmruder vvmruder merged commit dfcb73b into master Nov 3, 2023
11 checks passed
@vvmruder vvmruder deleted the update_installation_docs branch November 3, 2023 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants