-
Notifications
You must be signed in to change notification settings - Fork 64
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
Fix small bug in mkdocs #178
Conversation
Codecov Report
@@ Coverage Diff @@
## master #178 +/- ##
======================================
Coverage 94.1% 94.1%
======================================
Files 21 21
Lines 1189 1189
======================================
Hits 1120 1120
Misses 69 69 |
@jayqi this fixes the same issue in cloudpathlib that we just fixed in zamba if you have a chance to look it over. Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @klwetstone! One minor change.
@jayqi updated! should be good to merge once the tests finish |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Works like a charm. Thanks @klwetstone!
watch
ofmkdocs.yml
so building docs locally worksmake docs-serve
that serves the docs on a site locallyThe standard mkdocs project setup actually has
mkdocs.yml
in the project root, and would builddocs/
intosite/
(as opposed todocs/docs/
intodocs/site/
). We've wrapped things into a subdirectory layer ofdocs/
that is non-standard to keep the root level cleaner (credit to Jay for the explanation!). To refer to the right place when building docs locally, we need:Instead of
In
mkdocs.yml