Commit Graph
186 Commits
Author SHA1 Message Date
Benjamin Balder Bach c6fa4e7a40 Move context logic for layout.html to jinja (#1356)
* Revert "Update layout.html to support a sphinx version that is not three-integers (#1345)"

This reverts commit 45cf21874f.

* Always slice list before unpacking so number of elements is expected range

`map` filter returns a generator that needs to run through the `list` filter before slicing

* Let's keep it a 3-tuple but always set 3rd component to -1 -- in case a project was unpacking 3 values
2022-10-12 20:54:10 +02:00
Benjamin Balder BachandAnthony b33f27cf95 Adds changelog for 1.1.0alpha1 (#1353)
* Adds changelog for 1.1.0alpha1

* Update docs/changelog.rst

Co-authored-by: Anthony <aj@ohess.org>

Co-authored-by: Anthony <aj@ohess.org>
2022-10-07 21:53:50 +02:00
695a4e164c Update Breadcrumb Styles (#1073)
* Update Breadcrumb Styles

- Fixes extra padding to the left/right
- Used slash instead of >>
- Make literalls match other link style
- Adds demo docs for testing

* Update comment

* Update src/sass/_theme_breadcrumbs.sass

Co-authored-by: Ana Costa <anacosta.xl@gmail.com>

* Build theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1073

* Build theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1073

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
Co-authored-by: Ana Costa <anacosta.xl@gmail.com>
2022-08-27 22:47:23 +02:00
Ana CostaandBenjamin Bach ba0dc62448 CSS: Add overflow-wrap to links inside paragraphs (#1193)
* Add overflow-wrap to links inside paragraphs

* Add regression test for very long URLs

* Build theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1193

* build theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1193

* Build theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1193

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
2022-08-27 22:27:59 +02:00
Aaron CarlisleandBenjamin Bach 15fdfa15dc Fix definition lists inside api docs (#1084)
* Fix definition lists inside api docs

This is similar to #1080 (and is needed to fix citations in the demo here)

Fixes #1052

* Build Assets

* Build Assets 2

* New build of theme.css and theme.js

* Regenerate theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1084

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
2022-08-27 22:04:31 +02:00
Ana CostaandBenjamin Bach b2f52f4328 Fixes #289: Inconsistent table typography sizing (#1215)
* Fix table typography inconsistent sizing

* Remove rule duplication

* Remove <ol> and fix build

* Build new theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1215

* Add an example rendering with paragraphs inside tables

* build theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1215

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
2022-08-27 00:55:59 +02:00
Aaron CarlisleandBenjamin Bach 90463f0abe Fix #1078: Citation not styled properly (#1080)
* Fix #1078: Citation not styled properly

Turns out our demo docs werent being rendered by sphinx as citations so this may have slipped though the sphinx 2 fixes.

I updated the demo docs and included the need style fixes.

* Group citations and footnotes

* Build Assets

* Build theme.css with "Fix #1078: Citation not styled properly #1080"

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
2022-08-26 21:37:36 +02:00
Benjamin Bach 3d75e7c8f0 Fix a wrong example, replace non-existing Body Elements with References 2022-08-24 22:55:45 +02:00
Benjamin Bach ba059c7970 Wrapping up the Docker work, using docker cp again in order to copy assets out of containers 2022-08-24 16:49:29 +02:00
Benjamin Bach 4393bd2039 Merge remote-tracking branch 'upstream/master' into dockerize 2022-08-23 23:40:55 +02:00
Benjamin Bach 445c923e2f Merge remote-tracking branch 'upstream/master' into dockerize 2022-08-23 23:40:23 +02:00
Benjamin Bach 83e122054c Removes Makefile + double FROM in Dockerfile 2022-08-20 00:38:26 +02:00
Benjamin Bach ba65499354 First updates migrating to docker-compose 2022-08-20 00:20:45 +02:00
Benjamin Bach 7c43f45c9b Do not build the python package in this step 2022-08-19 22:50:49 +02:00
Benjamin Bach 8e737d4c84 Make note about releasing package-lock.json 2022-08-19 22:46:19 +02:00
Benjamin Bach e844040101 Build everything one step at a time 2022-08-19 22:38:22 +02:00
Benjamin Bach 8e65b61666 Adds wheel and a command to package bdist_wheel + sdist 2022-08-19 22:23:32 +02:00
Benjamin Bach b50a451097 Remove some text @agjohnson 2022-08-19 21:14:51 +02:00
Benjamin Bach 5087916a03 Do not bump the version in auto-maintained file package-lock.json 2022-08-19 17:46:30 +02:00
Benjamin Bach 0f76e9ba4a Merge branch 'master' of github.com:readthedocs/sphinx_rtd_theme into HEAD 2022-08-19 15:50:16 +02:00
Benjamin Bach 85123c47de Add a demo with Python types (regression test for #1196), rebuild theme.js 2022-08-19 15:47:32 +02:00
Benjamin Bach 19977256de Docker configuration for dev environment 2022-08-19 15:07:01 +02:00
Anthony Johnson 1b4263eadf Update to next development release after 1.0.0
For now, we'll be a bugfix release at 1.0.1 but do anticipate we'll be
adding features this release and will get to 1.1.0.

Requires #1230
2021-09-09 12:42:01 -06:00
Anthony Johnson 9fd4b0269b Add development version back to docs 2021-09-09 12:40:47 -06:00
Anthony Johnson 1f0ba51ec4 Update docs and versions for 1.0.0 release
The RC hasn't raised many issues, so time to move forward with final
release. This will be followed by a PR for 1.1.0-dev1.
2021-09-09 12:35:36 -06:00
Anthony Johnson b557851511 Make section labels verbose to avoid numeric labels
Perhaps this is a feature of Sphinx I'm not aware of, but using a
version number as the section label resulted in ``#id1`` instead.

I tried autosectionlabel, but as expected there were a lot of errors and
I don't feel it's worthwhile to spend time fixing them right now.
2021-08-23 16:17:49 -06:00
Anthony Johnson b880004ce0 Replace include of readme on index with actual content
If we want the Readme to have more links, this breaks linking at the
index page in the built documentation. The version is hardcoded in links
in the readme version, and hardcoded links point to the wrong version in
the documentaiton
2021-08-19 13:23:00 -06:00
Anthony Johnson bdd49c4eb3 Small fixes 2021-08-19 13:23:00 -06:00
Anthony Johnson 022a58f68e Replace outdated information on installation page
Repoint compatibilities to development information page instead.
2021-08-19 13:23:00 -06:00
Anthony Johnson 207ae966ec Add development and usage documentation
This finally defines our supported browsers and dependencies publicly,
and communicates our next several versions that we have planned so far.
This information is starting with 1.0.0, but I did try to capture some
historical information as well.
2021-08-19 13:23:00 -06:00
Anthony Johnson e1b8d2f54c Bump for next potential release
This is just the release version for development purposes so far.

Requires #1204
2021-08-17 11:03:09 -06:00
Anthony Johnson c5846e3128 Update translations for 1.0.0rc1
Also note the translation updates in changelog.
2021-08-17 10:01:31 -06:00
Anthony Johnson 3f75a24924 Bump2version release 2021-08-16 11:30:03 -06:00
Anthony Johnson 4c76eac561 Update changelog since last release 2021-08-16 11:28:08 -06:00
Anthony Johnson e026647701 Update release docs 2021-08-10 16:46:15 -06:00
Anthony Johnson b74323c2ae Add changelog automation with bump2version 2021-08-10 16:39:41 -06:00
Anthony Johnson f5b02911ae Update docs to note 1.6 as lowest version 2021-08-02 18:01:55 -07:00
Anthony Johnson 02d8fe0764 Add docs on qa testing theme changes 2021-07-19 17:57:57 -06:00
Aaron Carlisle b2323ce07f Merge branch 'master' into Blendify/python-compat 2021-06-22 18:47:00 -04:00
ThomasTNOandAaron Carlisle ef9a0584ef Added support for gtag (#1129)
* Added support for gtag

* Fix missing curly braces

* Simplify gtag script import

* Fix tag

* Add gtag to docs

Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2021-06-18 13:59:46 -04:00
Aaron Carlisle 2f12da38c6 Add Missing version bumps for 0.5.2 (#1120)
Found while looking into #1117
2021-04-08 20:40:33 -04:00
Aaron Carlisle 60a094bb13 Merge branch 'master' into Blendify/python-compat 2021-04-08 17:19:58 -04:00
Eric HolscherandAaron Carlisle ca2719b32f Merge Release 0.5.2 Changelog into master (#1114)
* Setup: Require docutils<0.17'

Docutils 0.17 changes some rendering of properties, until support is added we should probably pin to use an older version.

I may not be a bad idea to keep a pinned version in the theme to prevent this issue in the future.

* Release 0.5.2

Include a changelog and bump versions

* Fix changelog

Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2021-04-05 13:14:49 -04:00
Aaron Carlisle aa28eecc3a Docs: Fix intersphinx_mapping (#1110)
Sphinx documentation has moved from https://www.sphinx-doc.org/en/stable/ to https://www.sphinx-doc.org/en/master/

Fixes the command line message:
```
intersphinx inventory has moved: https://www.sphinx-doc.org/en/stable/objects.inv -> https://www.sphinx-doc.org/en/master/objects.inv
```
2021-04-02 12:21:54 -04:00
Aaron Carlisle fe934ec0d4 Merge branch 'master' into Blendify/python-compat 2021-03-29 22:08:21 -04:00
Aaron Carlisle 7417ff92bd Update Changelog for v1.0 (#1103)
This includes all major affecting changes that have already been committed to master since the last release.
2021-03-29 19:08:22 -04:00
Aaron Carlisle 4d196ce134 Add python version requirements to setup.py
This is need in the future so we can gracefully remove python 2.7 support.
See #1075.
2021-03-17 18:29:02 -04:00
Aaron Carlisle 114fb85b44 Require Sphinx 1.6 deprecate html4 (#1091)
Sphinx 1.6 is required for de76c03824 we also do not test against versions lower than 1.6 so we should safely drop it.

This is similar to #1076 and #1075 but less strict
2021-03-15 18:05:20 -04:00
Santos Gallegos f8e71bf312 Don't require npm to build from source (#1039) 2021-03-15 10:12:50 -05:00
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