Skip to content

Create the documentation #13

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

Merged
merged 9 commits into from
Apr 10, 2023
Merged

Create the documentation #13

merged 9 commits into from
Apr 10, 2023

Conversation

btschwertfeger
Copy link
Owner

@btschwertfeger btschwertfeger commented Apr 10, 2023

Summary

The doc strings were extended - to use them in the new sphinx-based documentation.
This new documentation can be found at https://python-cmethods.readthedocs.io/en/stable when the release v1.0.0 is published.


Closes #9

@btschwertfeger btschwertfeger added the Documentation Improvements or additions to documentation label Apr 10, 2023
@btschwertfeger btschwertfeger added this to the v1.0.0 milestone Apr 10, 2023
@btschwertfeger btschwertfeger self-assigned this Apr 10, 2023
@btschwertfeger btschwertfeger linked an issue Apr 10, 2023 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Apr 10, 2023

Codecov Report

Merging #13 (2a06a8c) into master (41e37c1) will decrease coverage by 0.01%.
The diff coverage is 100.00%.

❗ Current head 2a06a8c differs from pull request most recent head f26157d. Consider uploading reports for the commit f26157d to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #13      +/-   ##
==========================================
- Coverage   99.54%   99.54%   -0.01%     
==========================================
  Files           1        1              
  Lines         221      219       -2     
==========================================
- Hits          220      218       -2     
  Misses          1        1              
Flag Coverage Δ
unittests 99.54% <100.00%> (-0.01%) ⬇️

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

Impacted Files Coverage Δ
cmethods/CMethods.py 99.54% <100.00%> (-0.01%) ⬇️

@btschwertfeger btschwertfeger marked this pull request as ready for review April 10, 2023 15:03
@btschwertfeger btschwertfeger merged commit 31998f9 into master Apr 10, 2023
@btschwertfeger btschwertfeger deleted the 9-create-a-documentation branch April 10, 2023 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a documentation
1 participant