* Remove instructions "encouraging" to install directly from git
* Update changelog: Add reminder that people should not install directly from git
* Update docs/changelog.rst
---------
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
* 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>
* Changelog for 1.2.2
* 1.2.2rc1
* Build: Fix bug that reads out container id from previous run
* Update package-lock to match release
* Bump to 1.2.2 final
* 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
* Typo in recommended pinning
The paragraph above recommends "less than the next major version". But the example says `<=`. Make them match
* Update development.rst
* Drop development version header from changelog
This makes just as much sense as a point release header, and won't
require any special attention when we're cutting a release.
* Bump release 1.2.0
* Update package lock
* Sphinx 6: Use logo_url instead of logo
* Handle removal of favicon template context + refactor display of logo and link so it's easier to see what belongs to <4.0 and what is >=4.0
* Adds a favicon to the demo
* Import condensed version logic @agjohnson
* Update sphinx_rtd_theme/layout.html
Co-authored-by: Anthony <aj@ohess.org>
Co-authored-by: Anthony <aj@ohess.org>
* 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
* Add changelog entry for docutils 0.18 support
* Update docs/changelog.rst
Co-authored-by: Anthony <aj@ohess.org>
Co-authored-by: Anthony <aj@ohess.org>
* Add docutils 0.18 citation/footnote support using CSS grid
This is a fix for #1322 that continues our pattern for HTML5 support
using CSS grids, introduced for support for docutils < 0.17 HTML5
support.
* Add lots of backreferences to a footnote
* Drop brackets from footnote/citation links
The brackets seem to be another docutils addition.
* Tune grid display for Sphinx 4 and 5
Backrefs have a new styling that drops a lot of punctuation
* Bump dependency on docutils to < 0.19
* Small tweak to footnote backrefs row span
We don't want to use too large a value here, as some browsers might make
explicit rows for us. We can't target -1 because the row count is
implicit.
* Revert some new styling and use nonbreaking backrefs for now
* Downgrade tox
* Use before pseudo class to break up backrefs consistently
* Docs: Clean up several broken cross-references
* Adds a section about upgrading the theme and add navigation structure to installation guide
* Add a reference from Changelog to "How to upgrade"
* Also don't import sphinx_rtd_theme in the theme's own docs/conf.py
* Remove trailing linebreaks
* Update docs/installing.rst
Co-authored-by: Anthony <aj@ohess.org>
* Apply suggestions from code review
Co-authored-by: Anthony <aj@ohess.org>
* Update docs/installing.rst
* Replace guidance with reference to Reproducible Builds
* Build link into sentence
* Update the tip about using build logs and the need to pin the theme for older projects
* Remove tip box for Read the Docs users re: @agjohnson's request
Co-authored-by: Anthony <aj@ohess.org>
* 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>
* Update __init__.py because it wasn't updated by previous bump2version
* Add some comments about docker mechanisms that are disturbing release workflow
* Bump to version 1.1.0b3
* Revert "Bump to 1.1.0b2, rebuild assets"
This reverts commit 615eb528cc.
* Add changelog entry for #1073
* Changelog entry for #1193
* Bump to 1.1.0 using bump2version
* Use PEP440 and make it a beta, i.e. "1.1.0b1"
* Auto-generated package-lock.json but with version bumps
* Bump to 1.1.0b2, rebuild assets
* 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
* 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>
Anthony
Manuel Kaufmann
Benjamin Balder BachandManuel Kaufmann
Tapple Gao
Miller Abel
Benjamin Balder Bach
