-
Notifications
You must be signed in to change notification settings - Fork 29
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
WIP Switch To mkdocs #213
base: master
Are you sure you want to change the base?
WIP Switch To mkdocs #213
Conversation
Codecov Report
@@ Coverage Diff @@
## master #213 +/- ##
===========================================
- Coverage 94.97% 28.72% -66.25%
===========================================
Files 97 90 -7
Lines 16572 15742 -830
Branches 1634 1616 -18
===========================================
- Hits 15739 4521 -11218
- Misses 548 10977 +10429
+ Partials 285 244 -41
|
The RTD build is failing because this PR deletes |
Now RTD is able to compile the docs but there are no docs here https://hangar-py--213.org.readthedocs.build/en/213/ BTW I just found this paragraph on the mkdocs documentation (https://mkdocs.readthedocs.io/en/stable/user-guide/deploying-your-docs/#read-the-docs):
What do we do know? |
Motivation and Context
Why is this change required? What problem does it solve?:
better documentation generator.
Does not work at the current moment (unhappy with API plugin for numpy style docstrings).
Types of changes
What types of changes does your code introduce? Put an
x
in all the boxes that apply:Is this PR ready for review, or a work in progress?
How Has This Been Tested?
Put an
x
in the boxes that apply:Checklist: