Merge 1.0.dev into Master #1296
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
MkDocs most likley will no longer run on Python 2.6. All relevant tests have been removed. Closes mkdocs#165.
Related to mkdocs#1168.
…tch themes. Related to mkdocs#1168.
waylan
force-pushed
the
dev
branch
2 times, most recently
from
9e9f09b
to
481d989
Compare
All Markdown handling is now contained within the `Page` object, which external code no longer needs to know the internals of. A slightly different approach to the work started in mkdocs#713. Include the multimarkdown meta-data parser from docdata See: https://github.com/waylan/docdata Tests have been updated. However, as noted in mkdocs#713, they could use some refactoring. The existing tests all pass. We can leave refactoring as a seperate matter from this. Closes mkdocs#713.
Themes now have `theme` objects, and theme specific configs. Themes can inherit from other themes. Users (and theme authors) can define custom static templates and variables.
See the included documentation for a full explanation of the API.
Search has been removed and wrapped in a plugin (named "legacy_search").
The search feature was ported as-is. None of the open issues with search
have been addressed. Presumably, a new search plugin will be built from
the ground up which addresses those issues.
Note that there is no 'default' plugins. That means that users get no
search unless they enable it in the config by adding the following to
their `mkdocs.yml` file:
plugins:
- legacy_search
Fixes mkdocs#206
This option type can be used to validate that a specified file exists.
- makes events available in a module constant - can be used by plugins for inspection - ensures that registered attributes are actually callable - does not ignore other results than None that also evaluate as False in a condition
This can be used for a sequence of SubConfigs.
Also retains all errors of a plugin config.
This allows to override the loading of source files, e.g. to fetch it from a remote location or for generated contents.
Closed
jamesrhea
added a commit
to jamesrhea/mkdocs
that referenced
this pull request
Feb 15, 2018
"Officially added support for Python 3.6 (mkdocs#1296)" as of version 0.17.0. Source: http://www.mkdocs.org/about/release-notes/#version-0170-2017-10-19
waylan
pushed a commit
that referenced
this pull request
Apr 3, 2018
"Officially added support for Python 3.6 (#1296)" as of version 0.17.0. Source: http://www.mkdocs.org/about/release-notes/#version-0170-2017-10-19
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.
Let's move our primary development onto the 1.0 branch by merging that into master.
I have pushed up a 0.16 branch which is the current state of master. Any future bugfixes that would make for a good candidate for a 0.16.x bugfix release can then be backported from master. That's easier to manage than forward-porting bugfixes from master to 1.0.dev. It also removes the need to then merge all that back to master later (I had to resolve a lot of conflicts to get this in shape, don't want to have to do that again).
Warning, I rebased 1.0.dev with master, so any existing 1.0.dev clones/forks won't merge with this directly. However, I did the work in a private branch and have not pushed the rebase publicly. Therefore, the 1.0.dev branch here on GitHub is left alone for reference purposes. It should simply be considered inactive.