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 sphinx-docs & GH Pages #26

Merged
merged 78 commits into from
May 28, 2021
Merged

docs: add sphinx-docs & GH Pages #26

merged 78 commits into from
May 28, 2021

Conversation

AngryMaciek
Copy link
Owner

@AngryMaciek AngryMaciek commented May 28, 2021

Description

Project webpage ready; major refactoring; sphinx-docs

Fixes #18

Type of change

  • New feature (non-breaking change which adds functionality)
  • Documentation updated

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have not reduced the existing code coverage

@codecov-commenter
Copy link

Codecov Report

Merging #26 (add8da2) into master (a8bd564) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##            master       #26   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         5    -1     
  Lines          883       880    -3     
=========================================
- Hits           883       880    -3     
Impacted Files Coverage Δ
moranpycess/CustomExceptions.py 100.00% <ø> (ø)
moranpycess/Individual.py 100.00% <100.00%> (ø)
moranpycess/MoranProcess.py 100.00% <100.00%> (ø)
moranpycess/MoranProcess2D.py 100.00% <100.00%> (ø)
moranpycess/MoranProcess3D.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a8bd564...add8da2. Read the comment docs.

@AngryMaciek AngryMaciek marked this pull request as draft May 28, 2021 20:34
@AngryMaciek AngryMaciek marked this pull request as ready for review May 28, 2021 22:21
@AngryMaciek AngryMaciek merged commit da47d7b into master May 28, 2021
@AngryMaciek AngryMaciek deleted the docs branch May 28, 2021 22:29
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.

Proper documentation
2 participants