65 Commits

Author SHA1 Message Date
Dougal Matthews
a59ade70ec Bump version to 0.15.0 2016-01-21 09:48:48 +00:00
Waylan Limberg
ffbad6685b Update release notes 2016-01-14 20:22:04 -05:00
Waylan Limberg
bd33c4b76b Corrected lint errors in Markdown docs.
Also added README.md and CONTRIBUTING.md to the linter.

Note, that I am still getting one failer (in two locations). However
I consider that failer a bug in the linter and have reported it
upstream. We could disable that Rule (MD031), but as we are not
requiring the lint rules to pass presently, I just left it alone.

Also, while the code linter is set to allow lines 119 chars long,
I am using the Markdown linter's default of 80. Prose is easier to
read with shorter line lenghts, so I think it makes more sense to
use the default. Also, changing the default would have required
adding a config file. Adding a Ruby file for only one minor setting
seems silly, so I left it alone.
2015-08-13 10:18:34 -04:00
Dougal Matthews
567bee1cbf Add a note about including HTML files again 2015-07-25 15:08:02 +01:00
Dougal Matthews
a28dff0bcc Add the Page ancestors fix to the release notes 2015-07-25 15:02:05 +01:00
Dougal Matthews
fdce51d070 Add a note to the release notes for the TOC fix 2015-07-25 14:51:21 +01:00
Dougal Matthews
0c465a81d0 Change the deadline for Python 2.6 Removal
I was being a bit over eager.
2015-07-01 20:58:42 +01:00
Dougal Matthews
857ef4b3cf Start the deprecation of Python 2.6 support
See #165
2015-06-28 22:11:29 +01:00
Dougal Matthews
764b24be22 Added theme packaging to the release notes 2015-06-27 11:03:43 +01:00
Waylan Limberg
9a667c5337 Ensure consistent ordering of auto-populated pages.
Both files and directories should be sorted to ensure consistent ordering of
pages in the menus across builds and systems. Turns out to be a simple fix.
As `os.walk` provides a reference to the list of dirs it uses internally,
we can modify that list in place and it will use the modified list.

While this may not give proper alphanumeric ordering for all languages,
it goes ensure consistent ordering. For more control over ordering,
it is expected that a plugin could be used once that API becomes available.

Fixes #638.
2015-06-26 20:04:58 -04:00
Dougal Matthews
e16f9384ea Add site_author and site_description to the ReadTheDocs theme
Fixes #631
2015-06-16 09:24:26 +01:00
Dougal Matthews
7e9cdc7955 Added release notes for 48c0752 2015-06-12 15:59:23 +01:00
Dougal Matthews
3f89332156 Link to the Markdown, not the built output location
This means the links will work in GitHub etc.
2015-06-11 09:59:56 +01:00
Dougal Matthews
d4e87c3b6a Bump version 2015-06-09 10:07:48 +01:00
Dougal Matthews
a3dfa6af3a Done some quick editing to tidy the release notes. 2015-06-09 08:41:19 +01:00
Dougal Matthews
dfc14183aa Don't populate extra_templates be default
This is causing a number of users issues. So, this will now be a opt-in
feature only.

Fixes #616
2015-06-08 16:19:11 +01:00
Zenon Mousmoulas
0a152cf17e Add a note about mkdocs.toc.TOCParser handle_entityref() and handle_charref()
in release notes.
2015-06-08 05:15:58 +03:00
Dougal Matthews
eecd83b998 Refactor gh-deploy and remove ghp-import requirement
This change modifies ghp-import to be a library and uses it instead of
calling the package with subprocess.

Fixes #598
Fixes #547
2015-06-06 10:17:26 +01:00
Dougal Matthews
ca5d6f918f Enable gh-deploy to work if the mkdocs.yml is not in the repo root
Fixes #578
2015-06-06 10:17:26 +01:00
Sam Hatfield
dedcd6d179 Updated release notes
According to 2032e6beeb.
2015-06-05 19:07:11 +01:00
Dougal Matthews
0130a90f2b Fixed links in the contributing page 2015-06-05 08:36:08 +01:00
Isaac
91b3b0f5f6 Improve clarity of yaml loading function for maintenance
-Reorganize the yaml loading function to make it more clear what is
happening.
-Comment more to to make explicitly clear what is happening.
-Remove unnecessary 'pass'
-Make a note that 'finally' should be removed when the root of the issue
is cleared up.
-Update release notes with info on change.
2015-06-04 15:12:41 -06:00
Sam Hatfield
92cc5557da Updated release notes according to 8cf56b397b 2015-06-04 12:10:31 +01:00
Dougal Matthews
85f1765ef0 Merge pull request #584 from jetm/master
Add copyright footer for readthedocs theme
2015-06-04 11:54:26 +01:00
Waylan Limberg
975b216c79 Removed six dependency. 2015-06-03 11:26:12 -04:00
Javier Tia
6530101085 release-notes: mention copyright footer readthedocs theme change 2015-06-03 02:45:56 -06:00
Waylan Limberg
96b98145fd Added common options to CLI: -q & -v.
The --quiet and --verbose options can be called from any command (parent or
subcommands), yet they are only defined once. Code adapted from:
https://github.com/mitsuhiko/click/issues/108#issuecomment-44691173

If either or both options are defined more than once by the user, the last
option defined is the only one which controls.

No support of -vvv to increase verbosity. MkDocks only utilizes a few
loging levels so the additional control offers no real value. Can always
be added later.

Updated release notes.
2015-06-02 09:20:32 -04:00
Waylan Limberg
afadfcb2b4 Add short options (-a) to CLI.
Updated release notes.
2015-06-02 09:20:02 -04:00
Terrell Russell
8842d1d98f grammar 2015-06-02 08:05:55 -04:00
Dougal Matthews
a8783d63a1 Open up for 0.14 changes 2015-06-02 10:08:01 +01:00
Dougal Matthews
fd9140e7d5 If the site_dir is within the docs_dir, display a warning not an error 2015-06-02 09:10:29 +01:00
Dougal Matthews
24c22d7283 Add release notes for 0.13.2 2015-05-30 17:46:03 +01:00
Dougal Matthews
162d8a73dc Add release notes for 0.13.1 2015-05-27 08:18:46 +01:00
Dougal Matthews
f6b61d863c Add a note about installing the dev version
Fixes #548
2015-05-26 09:43:13 +01:00
Dougal Matthews
d2f6364c86 Planning to release tomorrow AOE 2015-05-25 17:47:21 +01:00
Dougal Matthews
7aa1aad841 More tweaks to the release notes 2015-05-25 16:19:36 +01:00
Dougal Matthews
26a414ffb3 Added missing release notes 2015-05-25 16:09:53 +01:00
Dougal Matthews
aeaa635a9a Remove reverted feature 2015-05-24 14:36:03 +01:00
Dougal Matthews
ca6db75a95 Start getting the 0.13 release notes together 2015-05-24 13:25:49 +01:00
Dougal Matthews
db9ca221bb Revert "Set zip_safe=False"
This reverts commit 196e30d6b1.
2015-05-06 16:43:25 +01:00
Dougal Matthews
196e30d6b1 Set zip_safe=False 2015-05-06 16:23:20 +01:00
Dougal Matthews
c3ab1cc95b Refactor the current CLI implementation to use Click
This reimplements the CLI interface to use Click, which in turn gives us
a much easier to use interface as it provides help messages for all the
commands and individual commands.

Fixes #259
2015-04-28 20:06:57 +01:00
Dougal Matthews
4991aada68 Added release notes for 0.12.2 2015-04-22 08:24:04 +01:00
Dougal Matthews
81f4d696ae Added a note about the point release 2015-04-14 09:31:14 +01:00
Dougal Matthews
7ef39aa4e2 Some minor updates to the documentation
- Added a small section about where to get help
- Updated link to the contributing guide
- Improved some o the code highlighting
2015-04-14 08:30:44 +01:00
Dougal Matthews
690e833f0b Add to the release notes 2015-04-13 17:08:27 +01:00
Dougal Matthews
3896349d58 Add the release notes for 0.12 2015-04-08 21:17:07 +01:00
Dougal Matthews
191d9fe25a Standardise the layout of the release notes 2015-04-08 21:16:44 +01:00
Dougal Matthews
bdbf2ce5ed Added an initial Contributing guide 2015-04-03 14:47:00 +01:00
Dougal Matthews
5cb1ee1ec3 Remove references to non-existant theme ghostwriter 2014-12-17 19:36:32 +00:00