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

docs: Add development guideline section #398

Merged
merged 1 commit into from
Aug 20, 2023
Merged

docs: Add development guideline section #398

merged 1 commit into from
Aug 20, 2023

Conversation

stotko
Copy link
Owner

@stotko stotko commented Aug 20, 2023

With Sphinx, we now have much better control over the layout and structure of the documentation. Add a development section to the documentation and include the changelog, a link to the license, as well as a significantly overhauled contributing guide. The latter further includes dedicated pages for the coding style, the documentation building, and testing.

As of now, the overhauled contributing guide links to the main page. This will be updated in the future when further parts of the documentation have been revised.

@codecov
Copy link

codecov bot commented Aug 20, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (a3bd45b) 97.40% compared to head (fb30d8d) 97.40%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #398   +/-   ##
=======================================
  Coverage   97.40%   97.40%           
=======================================
  Files          31       31           
  Lines        2581     2581           
=======================================
  Hits         2514     2514           
  Misses         67       67           

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

@stotko stotko merged commit c4b2fec into master Aug 20, 2023
55 checks passed
@stotko stotko deleted the development_docs branch August 20, 2023 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant