Skip to content

Read the config from properdocs.yml and fall back to mkdocs.yml#27

Merged
oprypin merged 2 commits intomasterfrom
yml
Mar 15, 2026
Merged

Read the config from properdocs.yml and fall back to mkdocs.yml#27
oprypin merged 2 commits intomasterfrom
yml

Conversation

@oprypin
Copy link
Copy Markdown
Member

@oprypin oprypin commented Mar 15, 2026

Support 'mkdocs.yml' as a fallback after 'properdocs.yml' is not found

Add a corresponding warning at INFO level

The order of preference can be seen directly in the code:

paths_to_try = ['properdocs.yml', 'properdocs.yaml', 'mkdocs.yml', 'mkdocs.yaml']

If the file is mkdocs.y*ml, then this warning is shown:

INFO    -  The configuration file 'mkdocs.yml' should be renamed to 'properdocs.yml', OR it should be passed explicitly on the command line: `-f mkdocs.yml`.
           Support for using this legacy file name as a fallback will eventually be removed from ProperDocs.

@oprypin oprypin changed the title Yml Read the config from properdocs.yml and fall back to mkdocs.yml Mar 15, 2026
Base automatically changed from getdeps to master March 15, 2026 18:16
@oprypin oprypin merged commit 5973753 into master Mar 15, 2026
36 of 38 checks passed
@oprypin oprypin deleted the yml branch March 15, 2026 18:32
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.

1 participant