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

[#2176] Set up documentation build with Sphinx #1166

Merged
merged 8 commits into from
May 23, 2024
Merged

Conversation

Bartvaderkin
Copy link
Contributor

@Bartvaderkin Bartvaderkin commented Apr 19, 2024

  • Config and CI workflow inspired by open-forms
  • Kept current old docs for now but fixed main issues to it completes CI
cd ./docs
make html
open ./_build/html/index.html

Taiga: #2443, #2445, #2444. #2446

@Bartvaderkin Bartvaderkin force-pushed the feature/2176-docs branch 5 times, most recently from 321d518 to f778198 Compare April 22, 2024 10:02
@codecov-commenter
Copy link

codecov-commenter commented Apr 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.21%. Comparing base (dec9dc8) to head (b745da2).
Report is 5 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1166   +/-   ##
========================================
  Coverage    95.21%   95.21%           
========================================
  Files          961      962    +1     
  Lines        34804    34807    +3     
========================================
+ Hits         33139    33142    +3     
  Misses        1665     1665           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Bartvaderkin Bartvaderkin requested a review from stevenbal April 23, 2024 07:11
@Bartvaderkin Bartvaderkin marked this pull request as ready for review April 23, 2024 07:11
Copy link
Contributor

@stevenbal stevenbal 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 overall, couple of comments/questions

.github/workflows/ci.yml Outdated Show resolved Hide resolved
.readthedocs.yaml Outdated Show resolved Hide resolved
.readthedocs.yaml Outdated Show resolved Hide resolved
src/open_inwoner/__init__.py Outdated Show resolved Hide resolved
docs/coding_style/index.rst Outdated Show resolved Hide resolved
@Bartvaderkin Bartvaderkin force-pushed the feature/2176-docs branch 7 times, most recently from f229909 to 679c9ee Compare April 29, 2024 10:32
Bart van der Schoor added 4 commits May 22, 2024 15:27
- Config and CI workflow inspired by open-forms
- Kept current old docs for now, fixed breaking issues
Copied from open-forms but without the changelog script
@pi-sigma pi-sigma force-pushed the feature/2176-docs branch 9 times, most recently from 4f43f83 to 079b318 Compare May 22, 2024 14:37
@pi-sigma pi-sigma force-pushed the feature/2176-docs branch from 079b318 to 4dbbfca Compare May 22, 2024 15:02
@pi-sigma pi-sigma changed the title [#2176] First pass at setting up docs builder [#2176] Set up documentation build with Sphinx May 22, 2024
@alextreme alextreme requested a review from pi-sigma May 22, 2024 15:31
@pi-sigma pi-sigma marked this pull request as draft May 23, 2024 08:08
@pi-sigma pi-sigma marked this pull request as ready for review May 23, 2024 08:22
@pi-sigma pi-sigma force-pushed the feature/2176-docs branch from 2548995 to 92855e0 Compare May 23, 2024 08:37
@alextreme alextreme merged commit ac7686e into develop May 23, 2024
18 checks passed
@alextreme alextreme deleted the feature/2176-docs branch May 23, 2024 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants