* Run tests and build docs with Sphinx 8.2
* CircleCI job
* Update Read the Docs dependencies
* Update matrix
* Run tests with 3.13
* Use 8.x to build our docs
* Tests: `sphinxdev` tox environment installs Sphinx from `master`
It seems we had a bug in the name and it wasn't installing Sphinx from `master`.
I expect this test to fail now because we pin `Sphinx<8`, but that's fine for now.
* Prepare for 3.0 release
- Drop Python <3.8
- Drop docutils <=0.18
- Add support for docutils 0.21
- Add support for Python 3.12
This follows the plan we wrote in
https://sphinx-rtd-theme.readthedocs.io/en/stable/development.html#roadmap-release-3-0-0
The main idea here is to move forward with newer versions and drop support for
old stuffs so we reduce the maintanence burden.
* Update CircleCI matrix
* More fixes to CircleCI
* Run test over Sphinx 8.0
* Update contributing guide
* Remove deprecated `readthedocs-sphinx-ext`
* Remove old Sphinx versions
* Uninstall our extension
* Show a warning if `extra_css_files` is in the `html_context`
See https://github.com/readthedocs/sphinx_rtd_theme/pull/450
* Update development page
* Add deprecate warning for `analytics_` theme options
* Update docs
* Remove unused dependency
Closes#1533
* Remove environment variables from our docs
This was already added in a more generic way to the theme itself.
* Require Sphinx >=6.0
* Deprecation warning about `get_html_theme_path`
See https://github.com/readthedocs/sphinx_rtd_theme/pull/1479#issuecomment-2296317034
It seems we had a bug in the name and it wasn't installing Sphinx from `master`.
I expect this test to fail now because we pin `Sphinx<8`, but that's fine for now.
* Visual test with Firefox and tox
Allows developer to run
```
tox -e py310-sphinx72-firefox
```
This will run the tests and open a Firefox after building the demo site
showing the `demo/demo.html` page on it.
Then, you can also run:
```
tox -e py310-sphinx61-firefox
```
and compare the visual differences.
Idea copied from #1388Closes#1388
* Default value for `DISPLAY` and `--new-tab`
* Simplify the idea :)
* 2.0 milestone: drop supported versions
The new policy is:
- Python >=3.6
- Sphinx >= 5
- HTML4 and HTML5 writer
- docutils >= 0.14, < 0.19
* Update roadmap after discussion
By the beginning of 2024 we should support newer Sphinx versions and HTML5 only.
* Remove Python 2.7 from CircleCI
* Run only supported versions on Python 3.11
* Update with feedback from review
* Update documentation to match our support
* Add Sphinx 6.2 that was missing
* Update tox/circleci to work
* Revert tox command
* Drop support for HTML4 and keep `-qa` testing
- drop support for HTML4 on 2.0
- keep `-qa` TOX environment to be able to compare feature branches
- emit `logger.errors` on Python 2 and html_writer4=True
- require Sphinx >= 5.0
- remove logic for old Sphinx versions
* Update Tox and CircleCI
* Update contributing page to match our plans
---------
Co-authored-by: Anthony Johnson <aj@ohess.org>
* Allow Sphinx 7
* Also build theme docs with Sphinx 7
* Add more tests cases on tox.ini
* Increase the Sphinx version for the docs
---------
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
* Remove version logic on sphinxcontrib-jquery, require >=4,<5
* Bump to Sphinx 6.1.x
* Remove testing for Sphinx 1.7, sphinxcontrib-jquery 4.x blocks it
* Allow Sphinx version 6 and add dependency for sphinxcontrib-jquery
* Adds Sphinx 6.0b2 to Tox test matrix
* Adds Sphinx 6 to relevant Circle CI pipelines
* Build docs with Sphinx 6.0b2
* Use stable Sphinx 6.0.0
* Do not overflow object cross references
* Rebuild theme for https://github.com/readthedocs/sphinx_rtd_theme/pull/1369
* Adds a demo for the regression
* Mock sphinx-automodapi for now, but we can use it soon
* we can replace sphinx-automodapi demo entirely with autosummary since it uses this under the hood
* We need a python 2.7 compliant test module. Add a short-term workaround until this is removed in 2.0.
* Add comment about the terrible tox workaround
* Use a less hacky way of conditional autosummary in demo API docs
- Use `only` directive for conditional reST instead
- Drops 1.6 from our text matrix, it was deprecated in 1.0 release.
There were issues with the conditional directive only on 1.6 for some
reason.
Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
Co-authored-by: Anthony Johnson <aj@ohess.org>
* Refines tox matrix, adds a new target "sphinxdev" that can test the latest upstream development branch
* Adds missing tox environments in circle ci config
* Remove odd undefined py2 and py3 tox environments
* Add Python 3.10 support
* Add new Sphinx versions to tox test matrix, but do not allow docutils >= 0.17 on Sphinx>=4.3
* Stop py2 and py27 support from sphinxlatest because of build breakage
* Circle CI: Repeat sphinx versions for Python 2.7 (pending adjustments)
* tox.ini config: Ensure that we are getting the expected Sphinx version
* Set sphinx versions for Python 3.10
* Add new Sphinx versions to tox test matrix, but do not allow docutils >= 0.17 on Sphinx>=4.3
* Stop py2 and py27 support from sphinxlatest because of build breakage
* Circle CI: Repeat sphinx versions for Python 2.7 (pending adjustments)
* tox.ini config: Ensure that we are getting the expected Sphinx version
* Adds support for explicit tox environments for html4/5
* Adds utility factors for py2/3, for easy access to the system python3
binary
* Adds a noop -qa postfix factor to make it easy to compare against
master or a tag
Sphinx 4.x moves javascript and css declarations to `script_files` and `css_files`. This patch fixes duplicatd link and script tags when using sphinx4
Sphinx 4.x changes the default setting of html_codeblock_linenos_style to 'inline' and deprecates `html_codeblock_linenos_style`. The css for `.hll` to make the hightling span the full line cause the line number and code to be split on seperate lines. I could not get the highlight to span the full line so it was removed completely. I also made line numbers not selectible by the user.
This changes also adds the needed changes to the tox testing enviorment alhough, sphinx4 is not officially released to pypi yet. You will need to test these changes locally using: `pip install git+https://github.com/sphinx-doc/sphinx@master`
The main change here is that we load information into the template so
that CSS can make decisions about what element hierarchy it can expect,
instead of covering both html4 and html5 writer with a single set of
rules. I also fixed the tox config so that it generates docs for
testing.
This is also in part going to revert the changes in #785. Instead of
maintaining a list of `dl` classes to apply the domain styles to, this
PR instead maintains a list of definition list classes to *not* apply
the domain definition list styling too. There are too many possibilities
to cover with an include list.
Benjamin Balder BachandManuel Kaufmann
Aaron Carlisle
Santos Gallegos
Santos Gallegos
Eric Holscher