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

Fix small bug in mkdocs #178

Merged
merged 3 commits into from Oct 20, 2021
Merged

Fix small bug in mkdocs #178

merged 3 commits into from Oct 20, 2021

Conversation

klwetstone
Copy link
Contributor

  • Fixes incorrect reference in watch of mkdocs.yml so building docs locally works
  • Adds a makefile command for make docs-serve that serves the docs on a site locally

The standard mkdocs project setup actually has mkdocs.yml in the project root, and would build docs/ into site/ (as opposed to docs/docs/ into docs/site/). We've wrapped things into a subdirectory layer of docs/ 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:

watch:
    ../cloudpathlib

Instead of

watch:
   cloudpathlib

In mkdocs.yml

@klwetstone klwetstone requested a review from jayqi October 20, 2021 13:39
@github-actions
Copy link
Contributor

github-actions bot commented Oct 20, 2021

@codecov
Copy link

codecov bot commented Oct 20, 2021

Codecov Report

Merging #178 (53a3b06) into master (cce6a2f) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master    #178   +/-   ##
======================================
  Coverage    94.1%   94.1%           
======================================
  Files          21      21           
  Lines        1189    1189           
======================================
  Hits         1120    1120           
  Misses         69      69           

@klwetstone
Copy link
Contributor Author

@jayqi this fixes the same issue in cloudpathlib that we just fixed in zamba if you have a chance to look it over. Thanks!

Copy link
Member

@jayqi jayqi left a 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.

Makefile Outdated Show resolved Hide resolved
@klwetstone
Copy link
Contributor Author

klwetstone commented Oct 20, 2021

@jayqi updated! should be good to merge once the tests finish

Copy link
Member

@jayqi jayqi left a 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!

@jayqi jayqi merged commit 3901746 into master Oct 20, 2021
@jayqi jayqi deleted the mkdocs-fix branch October 20, 2021 16:02
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.

None yet

2 participants