242 Commits

Author SHA1 Message Date
Waylan Limberg
93dc82e027 Release version 0.16.0 2016-11-03 14:23:08 -04:00
Waylan Limberg
503ad7e9b6 Document using theme_dir and template blocks togeather. 2016-11-03 13:10:12 -04:00
Waylan Limberg
1a087f62ed Merge pull request #1068 from waylan/config-links
Clean up configuration.md links.
2016-10-06 15:19:13 -04:00
Waylan Limberg
d39743b17b Clean up configuration.md links.
They were a mess. Fixes #1058
2016-10-06 14:46:41 -04:00
Michael William Boldt
fdd6e5ac52 Fix typo (Stardard -> Standard) 2016-10-06 10:13:30 -05:00
Waylan Limberg
fa2c1f3823 Added a screenshot to help with Windows installation.
This is, after all, the most commonly encountered problem by users.
At least it seems to be.
2016-09-28 10:15:18 -04:00
Waylan Limberg
aebfcdc39c Merge pull request #1026 from waylan/global_vars
Global Template vars refactor
2016-09-28 09:07:12 -04:00
Waylan Limberg
384428bc5e Added some system specific installation instructions.
Added a section covering package managers and some more notes
about Windows (specificly about adding Python to the PATH).
Fixes #932.
2016-09-27 20:19:02 -04:00
Waylan Limberg
f5b5446b71 Use absolute URLs in nav & media links from error templates.
An error page can be served from any location and therefore it is
impossable to pre-build an error page with correct relative URLs.
With absolute URLs, the error pages will properly link to other
pages in the nav as well as media files (css, js, images, etc) from
the template regardless of the actual URL the file is served from.

However, to continue to support environments where the docs root is a subdir
of the server root, all other pages must continue to use relative URLs.
The `site_url` is used to determine the server root when building
absolute URLs for the error page to ensure those URLs continue to work
in that type of environment.

Relative URLs are also nessecary for those who browse the site on the
local file system (via `file://`). In that case, the error page will be
broken. However, as error pages are not served by a local file system,
this is no more than a minor inconvience. Error pages should always be
tested from a server environment.

Fixes #77.
2016-08-29 10:14:09 -04:00
Waylan Limberg
de2a7370de Fix a couple markdown lint errors.?? 2016-08-25 21:42:41 -04:00
Waylan Limberg
1444523c0a Update release notes for recent commits. 2016-08-25 21:40:39 -04:00
Waylan Limberg
50e1734490 Deprecate site_favicon config setting and favicon template var
Templates need only include `{{ base_url }}/img/favicon.ico` and
users only need to create a file at `img/favicon.ico` in their
`docs_dir`.

Fixes #725.
2016-08-18 14:24:12 -04:00
Waylan Limberg
b4ddc867ec Improve installation instructions. (#1028)
Remove chocolately recomendation, which was never any good for Python.
2016-08-16 21:00:07 -04:00
Waylan Limberg
2641b6409d Refactor global template variables.
Any template variables which mirrored a config setting have been deprecated
and should be accessed via the coresponding config template variable.

This resolves the rest of #874.
2016-08-15 20:53:21 -04:00
Tom Christie
4a532be1f0 Deprecate include_nav and include_next_previous.
Fixes #679 and #681.
2016-08-15 20:39:53 -04:00
Waylan Limberg
b623323980 Add --force flag to gh-deploy command.
This replicates the recent addition to the ghp_import.py tool (see
https://github.com/davisp/ghp-import/commit/49cfe6e6).
The default is to not force, but if needed (perhaps when deploying
from a CI server), the --force flag can be included.

Fixes #973.
2016-08-11 10:27:07 -04:00
Waylan Limberg
8b6c13f0e0 Break up libs and scripts into 2 seperate template blocks.
Some scripts need to execute after the page has finished loading.
To ensure that, the `scripts` block is placed at the bottom of the page.

However, if a user embeds scrpts within the body, and those scripts
rely in libs, then the libs need to already be loaded. By having
`libs` be a seperate block at the top of the page (int he header),
we can ensure that will work.

And we still want the libs in a block so a user can override them,
or even add to them (via `{{ super() }}`).

Fixes #956
2016-08-10 15:58:05 -04:00
Waylan Limberg
ea02a2eea3 Deprecate auto-populating extra_css/javascript. 2016-08-09 22:50:35 -04:00
Waylan Limberg
63558bffe3 Enforce stricter docs_dir validation. (#996)
Raise an error when site_dir is in docs_dir (as opposed to a warning)
and raise an error when docs_dir is the parent dir of the config file.
Fixes #610 and #972.
2016-08-05 10:24:26 -04:00
Waylan Limberg
bc35869d34 Don't override config value for strict mode if not specified on CLI.
The different import path in __main__.py allows us to patch load_config.
See https://docs.python.org/3/library/unittest.mock.html#where-to-patch
Fixes #738
2016-08-04 14:44:39 -04:00
Andrew E Slaughter
81664fac4a A simple method for providing a quick/dirty reload option (refs #990) 2016-07-27 08:33:25 -06:00
Waylan Limberg
f4d0f11335 Document pages config setting default behavior.
Fixes #992. Not sure how this was missed.
2016-07-18 15:13:29 -04:00
Dougal Matthews
19677e69b4 Merge pull request #985 from d0ugal/issue/md
Remove extra theme_dir alias
2016-06-29 07:39:34 +01:00
Dougal Matthews
2c3e8c57aa Merge pull request #981 from d0ugal/issue/732
Add a note about 404 pages on the deploying page
2016-06-29 07:39:02 +01:00
Dougal Matthews
8091bcc2be Sort the links to make finding duplicates easier 2016-06-28 23:18:55 +01:00
Dougal Matthews
da56388055 Remove extra theme_dir alias
theme_dir is listed twice at the bottom links, this removed the
one that relates to this page. All usages make sense when linking
directly to the config page.
2016-06-28 23:10:53 +01:00
Dougal Matthews
06fab4bf3d Add a note about 404 pages on the deploying page
Fixes #732
2016-06-28 23:04:58 +01:00
Dougal Matthews
ec6f642d05 Merge pull request #980 from d0ugal/issue/coc
Adopt the PyPA Code of Conduct
2016-06-28 23:03:18 +01:00
Dougal Matthews
9a0e35c774 Adopt the PyPA Code of Conduct 2016-06-28 21:22:22 +01:00
Dougal Matthews
4bb605c6cb Add a note about the MkDocs team members.
We never explicitly listed people before, this should make it
clearer who is behind the project.

Fixes #950
2016-06-28 20:59:34 +01:00
Loren Gordon
b36646bef3 Use the edit url for the GitHub 'Edit on...' links 2016-06-28 10:59:20 -04:00
lorengordon
ac5a8a7b39 Direct edit links to individual pages
This patch adds support for a configuration option `edit_uri` that
is used to generate a link directly to an individual page in the
source repository.

Fixes #269
2016-06-27 16:38:30 -04:00
Dougal Matthews
176b722c1c Merge pull request #947 from waylan/template
Support theme customization with blocks
2016-05-31 10:28:24 +01:00
Brian J King
6b892249bc Fix typo in scp command
scp -r ./site command was missing the E in user.
2016-05-27 14:53:25 -05:00
Waylan Limberg
37a542cdb2 Improve documentation regarding template blocks. 2016-05-27 11:06:04 -04:00
Waylan Limberg
3c6504fd7d Support theme customization with template blocks
This is a backward incompatable change as it switches the primary
template from base.html to main.html.  See the release notes for
details.

Partially addresses #607.
2016-05-27 11:03:52 -04:00
Waylan Limberg
66b00e51da Follow links when copying media files.
Fixes #869.
2016-05-25 13:50:09 -04:00
Waylan Limberg
8b006bd7fd Support SOURCE_DATE_EPOCH environment variable for "reproducible" builds.
Fixes #938.
2016-05-16 19:45:55 -04:00
Saurabh Kumar
72e3992188 Fix minor typo in documentation 2016-05-11 22:59:03 +05:30
Waylan Limberg
f8a0ac6e03 Refactor page specific template variables.
A deprecation warning is issued for all old variables and all new
page specific variables are attributes of the 'page' object.

Global variables are uneffected, except page_description.

See the changes described in the release notes for details.

Fixes #874.
2016-05-01 19:40:00 -04:00
Dougal Matthews
b2cb385db3 Merge pull request #911 from waylan/theme-docs
Document theme_dir. Fixes #863
2016-04-29 15:42:22 +01:00
Dougal Matthews
d8d8341808 Fix the feedback from LinkChecker and enforce it in the Travis config 2016-04-29 11:09:48 +01:00
Waylan Limberg
4bb0c1cb1a Document theme_dir. Fixes #863 2016-04-27 11:49:37 -04:00
Waylan Limberg
e2e8dee2fd Update 0.16 release notes to include recent changes. 2016-04-26 13:22:11 -04:00
Jean Cruypenynck
4e889c451f Fix Markdown table syntax 2016-04-11 20:20:04 +02:00
Waylan Limberg
7e6962ff79 Enforce markdownlint test. 2016-04-06 15:49:07 -04:00
Waylan Limberg
fe40c9d1cf Updated Documentation Home Page/Tutorial.
* Updated screenshots to reflect the actual pages in the tutorial (fixes #870).
* Added a few new screenshots to demonstrate more features (search).
* Replaced the `initial-config.png` screenshot with a code block.
* Corrected the inconsistant use of "you" and "we" throughout (use "you").
* Added links to various locations in the docs where appropriate.
* General cleanup, formatting, etc.
2016-04-02 19:45:21 -04:00
Dougal Matthews
a59aa7c490 Add a node to the release notes 2016-03-09 09:04:39 +00:00
Dougal Matthews
614de78e9a Add release note for #728 2016-03-03 10:16:08 +00:00
Dougal Matthews
6e44264461 Add release notes for the two recent PRs 2016-03-03 09:39:45 +00:00