1148 Commits

Author SHA1 Message Date
Waylan Limberg
93dc82e027 Release version 0.16.0 2016-11-03 14:23:08 -04:00
Waylan Limberg
b5ca993f03 Merge pull request #1067 from waylan/theme-docs
Document using theme_dir and template blocks togeather
2016-11-03 13:23:44 -04:00
Waylan Limberg
503ad7e9b6 Document using theme_dir and template blocks togeather. 2016-11-03 13:10:12 -04:00
Waylan Limberg
532c743401 Merge pull request #1075 from waylan/dirty
Consistently use "dirty" to indicate dirtyreload server.
2016-10-17 10:13:28 -04:00
Waylan Limberg
96041b08a5 Consistently use "dirty" to indicate dirtyreload server.
Also removed the short option `-d` from the `--dirtyreload` flag to match
the other options. Fixes #1074
2016-10-17 09:39:37 -04:00
Waylan Limberg
e7d8879d2b Merge pull request #1033 from waylan/linter
Add linters for JS and CSS.
2016-10-09 20:51:12 -04:00
Waylan Limberg
78d1c01aa4 Add csslint to lint CSS.
Cleaned up the stylesheets as per csslint. Manually ignore adjoining-classes
to avoid more offenders being added later. Completely ignore order-aphabetical
as it occurs a lot and editing the stylesheet would make git blame less
useful in the future.
2016-10-09 20:32:18 -04:00
Waylan Limberg
e809185524 Add jshint to lint JS. 2016-10-09 10:05:15 -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
Waylan Limberg
204087c85c Merge pull request #1066 from mboldt/patch-1
Fix typo (Stardard -> Standard)
2016-10-06 11:39:04 -04:00
Michael William Boldt
fdd6e5ac52 Fix typo (Stardard -> Standard) 2016-10-06 10:13:30 -05:00
Waylan Limberg
569714a17f Merge pull request #1059 from waylan/search-modal
MkDocs Theme: search.html => search-modal.html
2016-09-30 11:39:16 -04:00
Waylan Limberg
432b0cdeee MkDocs Theme: search.html => search-modal.html
The `search.html` template name is a special name (hardcoded) which gets
written to the output if/when the theme includes a seperate search
page. However, the MkDocs theme uses a search modal instead. That does
not belong in a separate file in the output (it is included in `base.html`
template). By renaming the file, we still get the current fucntionality
(easy for users to override/replace the modal) but avoid generating a
broken `search.html` page in the output. Users can still create their own
standalone `search.html` file in the `theme_dir` is they want one, but now
they don't also break the modal when doing so.
2016-09-30 10:24:22 -04:00
Waylan Limberg
4370125969 Merge pull request #1053 from waylan/win-install
Added a screenshot to help with Windows installation.
2016-09-28 10:46:37 -04: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
bc851c5e49 Merge pull request #1052 from waylan/install
Added some system specific installation instructions.
2016-09-27 20:43:49 -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
6306ce402d Merge pull request #1039 from waylan/nav
Use absolute URLs in nav & media links from error templates.
2016-08-29 10:32:47 -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
c2a6f06e99 Merge pull request #1037 from waylan/code-css
Account for wide tables and wrap inline code spans.
2016-08-25 21:59:26 -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
d706bcb2e2 Give wide tables scroll bars in readthedocs theme.
The mkdocs theme doesn't need them as the entire page scrolls.
Besides, to get scroll bars on the table, a narrow table won't
strech across the page, which looks wierd with the table styling
used in the mkdocs theme (no borders, etc.).
2016-08-25 21:12:50 -04:00
Steven
3796099255 Consistent inline code wrapping.
Fixes #834.
2016-08-25 14:33:55 -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
Felix Krause
1cd9b3984b Update github.io URL (#1029)
- Add missing trailing / when printing out GitHub URL. Without the trailing `/` a GitHub error message is shown
- Switched from `http` to `https`, since it's now enabled by default by GitHub
2016-08-16 21:12:10 -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
Steven
2c547a4dc2 Better alignment for current selected menu item in readthedocs theme (#888) 2016-08-16 19:02:50 -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
50a30f0a06 Merge pull request #1023 from waylan/973
Add --force flag to gh-deploy command.
2016-08-11 13:15:04 -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
582523bcd3 Merge pull request #1022 from waylan/956
Break up libs and scripts into 2 separate template blocks.
2016-08-10 16:28:17 -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
77ca449714 Merge pull request #1020 from waylan/986
Deprecate auto-populating extra_css/javascript
2016-08-10 14:41:31 -04:00
Waylan Limberg
d3fc089398 Fully test pre/run/post_validation errors and warnings. 2016-08-10 14:09:47 -04:00
Waylan Limberg
ea02a2eea3 Deprecate auto-populating extra_css/javascript. 2016-08-09 22:50:35 -04:00
Dougal Matthews
7674eadad9 Start the deprecation of auto-populating extra_css and extra_javascript
See #986
2016-08-09 20:45:21 -04:00
Waylan Limberg
343b820f99 Merge pull request #1018 from waylan/testcli
Improve CLI Tests
2016-08-08 00:43:22 -04:00
Waylan Limberg
7c3df835d7 Add tests for CLI options.
Previously we only tested that the CLI commands called the approiate function.
Now we also test that the correct options are passed. A few recently
introduced bugs were caught while building these tests (fixed in the
previous couple commits).

Left off tests for the `json` command as it is being deprecated (see #481).

Closes #1016 and #1014.
2016-08-08 00:30:09 -04:00
Waylan Limberg
9e6243e32c Make --clean/--dirty consistent across commands. 2016-08-07 22:05:45 -04:00
memeplex
1156d210b5 Make livereload the default as stated by the docs. 2016-08-07 16:56:00 -03: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
c0c4e44caf Acknowledge SOURCE_DATE_EPOCH on individual pages. (#1010)
Fixes #938
2016-08-05 09:11:19 -04:00
jibbers42
536f8b48a7 Ensure docs_dir and site_dir aren't considered nested when the share a common prefix
Fixes #1011.
2016-08-05 09:06:08 -04:00
Waylan Limberg
ac1a3fd23c Merge pull request #1009 from waylan/738
Don't override config value for strict mode if not specified on CLI.
2016-08-04 15:02:10 -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
Waylan Limberg
2e4c2afca1 Merge pull request #997 from aeslaughter/dirty
A simple method for providing a quick/dirty reload option (refs #990)
2016-07-27 11:09:52 -04:00