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

Add Sphinx docs #55

Merged
merged 7 commits into from
May 12, 2022
Merged

Add Sphinx docs #55

merged 7 commits into from
May 12, 2022

Conversation

ewu63
Copy link
Collaborator

@ewu63 ewu63 commented May 11, 2022

Purpose

Partially addresses #14.

Expected time until merged

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

@ewu63 ewu63 requested a review from a team as a code owner May 11, 2022 17:59
@codecov
Copy link

codecov bot commented May 11, 2022

Codecov Report

Merging #55 (fecfdc8) into main (63ba8eb) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #55   +/-   ##
=======================================
  Coverage   21.25%   21.25%           
=======================================
  Files           3        3           
  Lines        2329     2329           
=======================================
  Hits          495      495           
  Misses       1834     1834           
Impacted Files Coverage Δ
cgnsutilities/cgnsutilities.py 26.96% <ø> (ø)

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@sseraj sseraj self-requested a review May 11, 2022 18:06
@ewu63
Copy link
Collaborator Author

ewu63 commented May 11, 2022

The docs are working now.

doc/conf.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@sseraj sseraj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add the badge to the README?

doc/index.rst Outdated Show resolved Hide resolved
doc/index.rst Outdated Show resolved Hide resolved
@sseraj sseraj changed the title Add spinx docs Add Sphinx docs May 11, 2022
@marcomangano marcomangano merged commit 89b97fe into main May 12, 2022
@marcomangano marcomangano deleted the add-docs branch May 12, 2022 15:26
@sseraj sseraj mentioned this pull request May 12, 2022
12 tasks
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.

3 participants