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

Refactor markdown loading #713

Closed
wants to merge 3 commits into
base: master
from

Conversation

Projects
None yet
2 participants
@d0ugal
Member

d0ugal commented Aug 15, 2015

Looking again at this work I started in #627 to try and push forward some much needed internal re-factoring.


If you want to review this, the second commit had all the internal updates and is the interesting one. The first just includes a dependency and the last updates all the tests so they match the internal changes.

The general goal here is to load the Markdown files much earlier in the process and split the markdown from the metadata. This then means the metadata is more widely available as an attribute of the Page object, and thus the metadata for a page is available to other pages during the build.


TODO:
  • A number of comments inline on the code need to be addressed, see below for those
  • Fix failing tests on Windows - I can't figure out what I've done to break these tests. It is somewhat strange, I am sure it is obvious but I am missing it.

@d0ugal d0ugal force-pushed the d0ugal:refactor-markdown-loading branch 2 times, most recently from 60082aa to b2ad246 Aug 15, 2015

use_directory_urls, docs_dir,
title=next_cat_or_title)
else:
raise Exception('Broken 2')

This comment has been minimized.

@d0ugal

d0ugal Aug 15, 2015

Member

This needs to be completed.

@d0ugal d0ugal force-pushed the d0ugal:refactor-markdown-loading branch 5 times, most recently from b6c9ba9 to 94752e9 Aug 15, 2015

d0ugal added some commits Aug 15, 2015

Refactor the process of working with Markdown files
This intentionally breaks the tests to keep the change small, the impact
on the test suite is far winder spread than on the internal code. This
really highlights flaws in our testing as so many of the different tests
are bound to the internals of this one area.

@d0ugal d0ugal force-pushed the d0ugal:refactor-markdown-loading branch from 94752e9 to 5e28e43 Aug 15, 2015

@d0ugal d0ugal closed this Jan 21, 2016

@waylan waylan added the Update needed label Feb 6, 2017

@waylan waylan added this to the 1.0.0 milestone Feb 6, 2017

@waylan

This comment has been minimized.

Member

waylan commented Feb 6, 2017

I'm reopening this as we need to address this and there is no specific issue open to track it. I've add the "update needed" label to remind us that the current code in his PR needs work.

@waylan waylan reopened this Feb 6, 2017

waylan added a commit to waylan/mkdocs that referenced this pull request Mar 17, 2017

Refactor Markdown handling.
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.

Tests still need updated.

waylan added a commit to waylan/mkdocs that referenced this pull request Mar 20, 2017

Refactor Markdown handling.
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.

Tests still need updated.

waylan added a commit to waylan/mkdocs that referenced this pull request Mar 24, 2017

Refactor Markdown handling.
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.

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.

waylan added a commit to waylan/mkdocs that referenced this pull request Mar 24, 2017

Include the multimarkdown meta-data parser from docdata
See: https://github.com/waylan/docdata

Refactor Markdown handling.

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.

waylan added a commit to waylan/mkdocs that referenced this pull request Mar 24, 2017

Refactor Markdown handling.
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.

waylan added a commit that referenced this pull request Mar 24, 2017

Refactor Markdown handling. (#1180)
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 #713.

Include the multimarkdown meta-data parser from docdata
See: https://github.com/waylan/docdata

Tests have been updated. However, as noted in #713, they could use
some refactoring. The existing tests all pass. We can leave refactoring
as a seperate matter from this.

Closes #713.

@waylan waylan closed this Mar 24, 2017

waylan added a commit to waylan/mkdocs that referenced this pull request Sep 28, 2017

Refactor Markdown handling. (mkdocs#1180)
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.

waylan added a commit to waylan/mkdocs that referenced this pull request Sep 28, 2017

Refactor Markdown handling. (mkdocs#1180)
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.

waylan added a commit to waylan/mkdocs that referenced this pull request Sep 28, 2017

Refactor Markdown handling. (mkdocs#1180)
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.

waylan added a commit to waylan/mkdocs that referenced this pull request Sep 28, 2017

Refactor Markdown handling. (mkdocs#1180)
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.

waylan added a commit that referenced this pull request Oct 1, 2017

Refactor Markdown handling. (#1180)
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 #713.

Include the multimarkdown meta-data parser from docdata
See: https://github.com/waylan/docdata

Tests have been updated. However, as noted in #713, they could use
some refactoring. The existing tests all pass. We can leave refactoring
as a seperate matter from this.

Closes #713.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment