Skip to content

Updated docs infrastructure #428

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 3 commits into from
Mar 27, 2022
Merged

Updated docs infrastructure #428

merged 3 commits into from
Mar 27, 2022

Conversation

abey79
Copy link
Owner

@abey79 abey79 commented Mar 26, 2022

Description

Updated docs infrastructure

  • migrated to furo theme
  • removed doc-related dependences from pyproject, added in docs/requirements.txt
  • cleaned up conf.py
  • added MyST, removed recommonmark (deprecated)
  • fixed some errors
  • update rtd conf file
  • updated deps

Checklist

  • feature/fix implemented
  • code formatting ok (black and isort)
  • mypy returns no error
  • tests added/updated and pytest succeeds
  • documentation added/updated
    • command docstring and option/argument help
    • README.md updated (Feature Overview)
    • CHANGELOG.md updated
    • added new command to reference.rst
    • RTD doc updated and building with no error (make clean && make html in docs/)

abey79 added 2 commits March 26, 2022 14:46
- migrated to furo theme
- removed doc-related dependences from pyproject, added in docs/requirements.txt
- cleaned up conf.py
- added MyST, removed recommonmark (deprecated)
- fixed some errors
- update rtd conf file
- updated deps
updated CHANGELOG.md
@codecov
Copy link

codecov bot commented Mar 26, 2022

Codecov Report

Merging #428 (4b7c870) into master (10d88dc) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #428   +/-   ##
=======================================
  Coverage   93.83%   93.83%           
=======================================
  Files          59       59           
  Lines        5210     5210           
  Branches      766      766           
=======================================
  Hits         4889     4889           
  Misses        205      205           
  Partials      116      116           

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 10d88dc...4b7c870. Read the comment docs.

- fixed a few formatting issue
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@abey79 abey79 merged commit dc899ce into master Mar 27, 2022
@abey79 abey79 deleted the doc-update branch March 27, 2022 10:22
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.

1 participant