docs: Fix mkdocs warnings for cleaner build output #1061
Merged
Conversation
This file contains 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
✅ Deploy Preview for dynaconf ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
pedro-psb
approved these changes
Feb 26, 2024
There was a problem hiding this comment.
Great! Thanks for the contribs.
I was unsure about prebuild_index, but it looks like its not supported for some time in mkdocs-material.
These files are not currently being used. They were suppose to prepare for a translated build, which was discussed in #797 and was being developed in #826. |
pedro-psb
added a commit
that referenced
this pull request
Mar 18, 2024
Shortlog of commits since last release:
Aaron DeVore (1):
docs: fix incorrect combination of TOML table and inline table (#1070)
Adam Kjems (1):
doc: replace dead link to flask subclassing page (#1031)
Bruno Rocha (2):
feat: Add `@get` converter to alias existing keys (#1040)
fix: dependabot alert 21 about Django (on tests) (#1067)
HAMASHITA (1):
chore: Fix misspelled variable name (#1032)
Lucas Limeira (1):
doc: Add explicit Dynaconf instantiation to sample code (#1022)
Mitchell Edmunds (5):
docs: Add dynaconf API to docs with mkdocstrings (#1058)
docs: Fix mkdocs warnings for cleaner build output (#1061)
chore: add "typos" tool and run it in codebase/docs (#1063)
Fix referencing issues in the docs (#1062)
chore(ci): Replace lint and formatting tools with ruff (#1074)
Mostafa Alayesh (1):
doc: fix argument `env` in Validation at validation.md (#1051)
Pedro Brochado (11):
chore(ci): Fix misspelled GitHub action names on main.yml (#1033)
chore(ci): move release workflow to GitHub actions (partial) (#1043)
chore(ci): fix shell script in release.yml
chore(ci): fix shell script in release.yml (2)
chore(ci): fix create-release-commit.sh permission
fix: include load with relative root path (#1049)
fix: `_bypass_evaluation` showing in end-user settings (#1071)
chore: Replace/Update release script (#1078)
docs: fix wrong info about validation trigger on insantiation (#1076)
misc: fix bump-my-version invalid config and rename bump msg
misc: fix changelog generation order
Shanshi Shi (1):
Fix a typo in the docs about `merge_enabled` setting (#1044)
Sun Jianjiao (1):
doc: Fix the syntax errors in the sample program. (#1027)
tdzz1102 (1):
[Doc] Fix a small mistake of .env file in the document (#1036)
xiaohuanshu (1):
doc: fix click help syntax error (#1041)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Working on a recent PR, the output from
mkdocs buildandmkdocs servewas very noisy because of warnings. This PR fixes them all to make the build clean. There were many like the first screenshot.Result
Much cleaner, only a few warnings around the Portuguese language docs which I wasn't sure how to deal with.
Other comments