docs: fix outdated make command in CONTRIBUTING - #3647
Open
wlumumba wants to merge 2 commits into
Open
Conversation
Replace 'make -C docs html' (Sphinx) with 'make docs' (mkdocs), which matches the actual Makefile target. Also update the reference from 'docs/source/settings.rst' to match the current mkdocs setup.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The contributing guide referenced
make -C docs html. The project has since migrated to mkdocs, and the correct command ismake docs(defined in the Makefile).Also removes the stale reference to
docs/source/settings.rst, which no longer exists