mkdocs 2.0.dev4__tar.gz → 2.0.dev6__tar.gz

{mkdocs-2.0.dev4 → mkdocs-2.0.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: mkdocs
-Version: 2.0.dev4
+Version: 2.0.dev6
 Summary: HTTP, for Python.
 Author-email: Kim Christie <noreply@lovelydinosaur.com>
 Classifier: Development Status :: 4 - Beta
@@ -24,13 +24,15 @@ Description-Content-Type: text/markdown
 
 MkDocs is a smart, simple, website design tool.
 
-Getting started is easy...
+## Installation
+
+To install MkDocs, run the following command from the command line:
 
 ```shell
-$ pip install mkdocs --pre
+pip install mkdocs --pre
 ```
 
-*This will install the version 2.0 pre-release.*
+This will install the version 2.0 pre-release.
 
 ## Getting started
 

mkdocs-2.0.dev6/docs/CHANGELOG.md

@@ -0,0 +1,17 @@
+## 2.0.dev6
+
+**RelativeURLs Bugfix**
+
+Bugfix for relative URLs. This was working correctly within the `mkdocs` project serving it's own documentation, so the breakage wasn't immediately obvious. [#56](https://github.com/encode/mkdocs/pull/56).
+
+## 2.0.dev5
+
+**Navigation Support Bugfix**
+
+Use relative URLs for site navigation. Ensures that sites hosted on a subpath still link correctly. [#54](https://github.com/encode/mkdocs/pull/54), [#55](https://github.com/encode/mkdocs/pull/55).
+
+## 2.0.dev4
+
+**Navigation Support**
+
+Preliminary support for site navigation. [#49](https://github.com/encode/mkdocs/pull/49).

{mkdocs-2.0.dev4 → mkdocs-2.0.dev6}/docs/README.md

@@ -2,13 +2,15 @@
 
 MkDocs is a smart, simple, website design tool.
 
-Getting started is easy...
+## Installation
+
+To install MkDocs, run the following command from the command line:
 
 ```shell
-$ pip install mkdocs --pre
+pip install mkdocs --pre
 ```
 
-*This will install the version 2.0 pre-release.*
+This will install the version 2.0 pre-release.
 
 ## Getting started
 

{mkdocs-2.0.dev4 → mkdocs-2.0.dev6}/docs/templates/base.html

@@ -13,7 +13,7 @@
     </head>
     <body>
         <nav class="site">
-            {{ nav.html }}
+            {% include "navigation.html" %}
         </nav>
         <nav class="toc">
             {{ page.toc.html }}

mkdocs-2.0.dev6/docs/templates/navigation.html

@@ -0,0 +1,3 @@
+<ul>
+    {% for item in nav %}<li><a href="{{ item.page.url | url }}"{% if item.page.url == page.url %} class="active"{% endif %}>{{ item.title }}</a></li>{% endfor %}
+</ul>

{mkdocs-2.0.dev4 → mkdocs-2.0.dev6}/src/mkdocs/__init__.py

@@ -1,5 +1,5 @@
 from .__version__ import __title__, __version__
-from .mkdocs import get_current_page, get_site, Page, Static, Site, MkDocs, cli
+from .mkdocs import get_current_page, get_site, link_to, Page, Static, Site, MkDocs, cli
 
 
 __all__ = [
@@ -7,6 +7,7 @@ __all__ = [
     '__version__',
     'get_current_page',
     'get_site',
+    'link_to',
     'Page',
     'Static',
     'Site',

mkdocs-2.0.dev6/src/mkdocs/__version__.py

@@ -0,0 +1,2 @@
+__title__ = "mkdocs"
+__version__ = "2.0.dev6"

{mkdocs-2.0.dev4 → mkdocs-2.0.dev6}/src/mkdocs/extensions/relative_urls.py

@@ -40,9 +40,7 @@ class URLProcessor(markdown.treeprocessors.Treeprocessor):
 
                     url_from = page.url
                     url_to = target.url
-                    rewrite = posixpath.relpath(url_to, url_from)
-                    if url_to.endswith('/') and rewrite != '.':
-                        rewrite += '/'
+                    rewrite = mkdocs.link_to(url_from, url_to)
                     if url.query:
                         rewrite += f'?{url.query}'
                     if url.fragment:

{mkdocs-2.0.dev4 → mkdocs-2.0.dev6}/src/mkdocs/mkdocs.py

@@ -37,6 +37,18 @@ def get_site():
     return ctx
 
 
+def link_to(path_from, path_to):
+    if path_from == path_to:
+        return '.'
+    p0 = path_from.split('/')
+    p1 = path_to.split('/')
+    for idx, pair in enumerate(zip(p0, p1)):
+        if pair[0] != pair[1]:
+            break
+    p = ['..' for i in p0[idx+1:]] + p1[idx:]
+    return '/'.join(p)
+
+
 class Page:
     def __init__(self, path):
         self.path = path
@@ -194,8 +206,7 @@ class MkDocs:
         @jinja2.pass_context
         def url(ctx, url_to):
             url_from = ctx['page'].url
-            url_rel = posixpath.relpath(url_to, url_from)  # This isn't correct
-            return url_rel
+            return link_to(url_from, url_to)
 
         dir = pathlib.Path(input_dir)
         loader = jinja2.ChoiceLoader([

{mkdocs-2.0.dev4 → mkdocs-2.0.dev6}/src/mkdocs/theme/base.html

@@ -263,7 +263,7 @@ nav.toc li a:hover {
     <body>
         {% if nav %}
         <nav class="site">
-            {{ nav.html }}
+            {% include "navigation.html" %}
         </nav>
         {% endif %}
         {% if page.toc %}

mkdocs-2.0.dev6/src/mkdocs/theme/navigation.html

@@ -0,0 +1,3 @@
+<ul>
+    {% for item in nav %}<li><a href="{{ item.page.url | url }}"{% if item.page.url == page.url %} class="active"{% endif %}>{{ item.title }}</a></li>{% endfor %}
+</ul>

mkdocs-2.0.dev4/docs/CHANGELOG.md

@@ -1,7 +0,0 @@
-## 2.0.dev4
-
-**Navigation Support**
-
-Preliminary support for site navigation.
-
-See [#49](https://github.com/encode/mkdocs/pull/49) for further details.

mkdocs-2.0.dev4/src/mkdocs/__version__.py

@@ -1,2 +0,0 @@
-__title__ = "mkdocs"
-__version__ = "2.0.dev4"