Commit Graph

137 Commits

Author SHA1 Message Date
Aaron Carlisle
85f23c9edc Docs: Add text before config api type information (#1090)
* Docs: Add text before config api type information

This makes it more clear what the confval is for without having to read through the type information.

This matches usual sphinx autodoc behavior.

* Only use one space above headings
2021-03-15 09:49:13 -05:00
Aaron Carlisle
ba1cbb1c07 Docs: Always use local theme (#1083)
This changes non PR builds on rtd to use the local theme and not the old 0.4.3 theme. We want our docs to show what the theme looks like based on the current release, not an old version.
2021-03-12 15:17:35 -05:00
Aaron Carlisle
8ba9c8ac0b Templates: Cleanup Whitespace (#1060)
While not perfect this cuts it down a lot and makes the html output much 
cleaner
2021-03-01 10:09:03 -05:00
Tobias Bengfort
c8ef0fc94f Fix aria label (#1056)
* Do not use the landmark role as part of the label

See https://www.w3.org/TR/wai-aria-practices/#general-principles-of-landmark-design

* translate aria-labels
2021-02-23 12:20:37 -05:00
Santos Gallegos
60e1c21211 Update intersphinx urls (#1048) 2021-02-10 20:13:53 -05:00
Santos Gallegos
5d0a396bf9 Docs: fix typo (#1036) 2021-01-11 21:01:54 -05:00
Santos Gallegos
f6554bfcbf Release 0.5.1 (#1032) 2021-01-04 17:13:31 -05:00
Santos Gallegos
c27ac2944b Use canonical URL from html_baseurl (#1003)
This is in sphinx itself now https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl,
e886cc2171/sphinx/themes/basic/layout.html (L135-L137)
2020-12-03 17:15:40 -05:00
Nils K
e2b60d7e7b Add analytics_anonymize_ip option to theme (#889)
* Add analytics_anonymize_ip option to theme

* Fix typo and use tobool filter

Co-Authored-By: Jesse Tan <jessetan@users.noreply.github.com>

* Simplify analytics_anonymize_ip description

* Update changelog.rst

Co-authored-by: Jesse Tan <jessetan@users.noreply.github.com>
Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2020-10-08 19:28:19 -04:00
Anthony Johnson
a452102fff Bump version 2020-06-17 09:55:10 -06:00
Anthony Johnson
b9e8328695 Update changelog for 0.5.0 2020-06-17 09:46:01 -06:00
Anthony Johnson
ac20ce75d4 Use only-child to limit margins on single paragraph list items
This is a compromise between the docutils intended style and more
consistent margins than 0.4.3.
2020-06-16 16:30:26 -06:00
Anthony Johnson
aa0a108543 Add complex list margins, use margin-less items for ul.simple margins
0.5.0 was moving in the direction of treating everything like a simple
list. 0.4.3 had some bugs that made complex lists look closer to the
spacing that complex lists use. This resolves both and adds specific
item margins for both cases.

See https://docutils.sourceforge.io/sandbox/html4strict/data/simple-lists.html
2020-06-16 13:54:47 -06:00
Anthony Johnson
73fe2fba49 Add changelog dates 2020-06-05 10:07:16 -06:00
Anthony Johnson
4de3f217a9 No, update changelog 2020-06-05 10:05:41 -06:00
Anthony Johnson
a7e656a8cf Update changelog 2020-06-05 10:04:54 -06:00
Anthony Johnson
6f0de13baf Fix a number of issues around margins on last children
The HTML4 writer depended on the `.last` selector, a class added by
Sphinx directly on output. Both writers are not using that method
anymore and instead relying on well supported CSS selectors.

This actually also addresses a number of inconsistencies with margin
spacing in lists. Version 0.4.3 and prior have a number of odd issues
around nested lists that are resolved with this change.
2020-06-05 09:50:22 -06:00
Anthony Johnson
33625141ec Address issue with dl.simple definition lists
This was not a test case in our demo docs, and I'm still not entirely
sure why the style needs to be different. 🤷

Fixes #913
2020-05-06 19:24:30 -06:00
Anthony Johnson
8732ce06b5 Bump to next release, 0.5.0rc2 or greater 2020-05-06 16:14:39 -06:00
Anthony Johnson
729ac2f5b9 Release 0.5.0rc1
This is a release candidate for 0.5.0, which adds support for both HTML4
and HTML5 writers, which should support the default writer regardless of
your version of Sphinx.

Also included in this release are localization efforts and 10 language
translations.

You will need to specify the release manually to test, if there are no
major issues, we will have a 0.5.0 release shortly.

Closes #886
Closes #712
2020-05-06 15:22:02 -06:00
Anthony
bcb142a463 Merge branch 'master' into use-bumpversion 2020-05-06 15:06:10 -06:00
Anthony Johnson
b4769ec0ae Start off with 0.4.3alpha1
We use a 1-based indexing for dev part as `rc0` sounds funny. This was
also a test commit of the change.
2020-05-06 14:53:43 -06:00
Anthony Johnson
512ad422d1 Move bumpversion config and reconfigure
I moved the configuration to setup.cfg, with the rest of the tooling
configurations.

I had trouble getting the parsing to work for both the current pattern
that exists in this repository (`0.4.3.dev0`), and the pattern we use in
other repositories (`0.4.3alpha1` and `0.4.3rc1`).

The release pattern would potentially be:

* Version is `0.4.3alpha1`
* Bump to `0.5.0alpha1` or `0.5.0rc1` for testing release, `0.5.0` for
  full release
* Commit, tag, etc the new release
* Release to PyPI
* Bump to `0.5.1alpha1` and commit. This is the next development release
  that would be in `master` branch
2020-05-06 14:47:03 -06:00
Anthony Johnson
fb84183e71 Remove debug line 2020-05-05 14:16:29 -06:00
Anthony Johnson
31e8ec71b5 Debug log theme location 2020-05-05 14:16:29 -06:00
Anthony Johnson
16d874d984 Use the local theme for PR builds on RTD 2020-05-05 14:16:29 -06:00
Anthony Johnson
20ca43724c Trigger PR builder with latest Sphinx version 2020-05-05 14:16:29 -06:00
Anthony Johnson
20abc2fc1c Add method to test badge only CSS
Also a small bug fix I found to line-height.
2020-05-05 14:16:28 -06:00
Sebastian Weigand
ca015a5704 Extend toc in sidebar indentation (#852)
* added vscode config to .gitignore

* implemented indentation for sidebar nav up to navigation_depth of 10

* removed .vscode from .gitignore

Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2020-02-24 21:55:07 -05:00
Jesse Tan
12458e0a6a Remove Modernizr, keep html5shiv (Webpack edition) 2019-10-25 14:54:52 +02:00
Aaron Carlisle
a4bacd2bab Docs: Fix use of code console 2019-10-23 11:08:08 -04:00
Reinout van Rees
c04c214a85 Documenting that google analytics is supported (#829)
See #411, released in `0.4.3`. It is now supported, so I've changed the documentation accordingly.
2019-10-23 04:36:31 -04:00
Jesse Tan
8d484197f2 Also bump version in documentation conf.py 2019-10-03 20:48:58 +02:00
Jesse Tan
80580324c8 Update instructions 2019-10-03 20:37:52 +02:00
Anthony
6947fea9c0 Merge branch 'master' into agj/setup-webpack-commands 2019-10-03 10:43:17 -06:00
Jesse Tan
085eb32179 Use bump2version for version number management 2019-10-03 12:09:36 +02:00
Anthony Johnson
e2a173d393 Add webpack commands into setup.py
This is a POC that shows building webpack through standard `setup.py`
commands. Any call to `setup.py build` or `bdist` or `sdist` will
trigger a Webpack build of the assets first. A non-zero exit code will
halt the process.

Also, moved the `npm run dev` command, which here is `python setup.py
watch`, though there is perhaps something better here. There is already
`python setup.py develop`, which has a separate function, so I don't
want to collide there.

Example output here:
https://gist.github.com/agjohnson/cdaab364fe598daa7f3bef750cfb84dd

Refs #797
2019-07-26 17:14:36 -06:00
Anthony Johnson
1bfa504f97 Add more domain doc examples
These are a few domain examples pulled from the Sphinx test doc roots.
2019-07-25 19:27:22 -06:00
Anthony Johnson
10d9f512ad Merge branch 'master' into style-cpp-domain 2019-07-25 18:11:13 -06:00
Anthony Johnson
a591817abe Forgot a changelog entry 2019-07-25 16:18:34 -06:00
Anthony Johnson
94d574349f Review fixes on typo and missing change to package.json 2019-07-25 15:46:31 -06:00
Anthony Johnson
472b3aee21 Final doc updates and fix tests 2019-07-25 14:08:56 -06:00
Anthony
26b72a7c61 Merge branch 'master' into style-cpp-domain 2019-07-25 13:27:17 -06:00
Anthony Johnson
d426c11cea Merge branch 'master' into agj/update-translations-rebase 2019-07-25 00:07:44 -06:00
Anthony Johnson
ad31326e3a Some final cleanup 2019-07-24 23:53:25 -06:00
Anthony Johnson
5052143f79 Undoing test fixes 2019-07-24 23:42:25 -06:00
Anthony Johnson
0e0ccffe18 Replace with requirements file, RTD doesn't handle these patterns well. 2019-07-24 23:36:13 -06:00
Anthony Johnson
16e36af58c Another test 2019-07-24 19:24:16 -06:00
Anthony Johnson
715c0beacb Add commands into setup.py and regenerate translations
More fixes for docs
2019-07-24 18:39:35 -06:00
Anthony Johnson
d216dcf54d Fix local path insertion of package, fix more docs
Add back git installation docs, we'll discuss this separately.
2019-07-19 15:29:24 -06:00