Commit Graph

22 Commits

Author SHA1 Message Date
bastimeyer d4ebface98 docs: bump furo theme version to 2024.04.27 2024-04-28 00:09:33 +02:00
bastimeyer 7c4bb8c4d6 docs: bump myst-parser dependency requirement 2024-04-23 18:49:21 +02:00
bastimeyer 83a6315afe build: add support for versioningit >=3.0.0
Keep backward compatibility for `versioningit <3.0.0`
2023-12-14 05:17:18 +01:00
bastimeyer 2f64123093 build: fix setuptools in {dev,docs}-requirements 2023-12-09 07:40:27 +01:00
bastimeyer 4f65b9a97d docs: bump furo theme version to 2023.09.10 2023-09-10 17:21:39 +02:00
bastimeyer 3cd4378a4d docs: bump furo theme to 2023.07.26
- Bump furo sphinx theme to latest version
- Require sphinx >=6.0.0
2023-07-28 18:29:24 -07:00
bastimeyer 65008d19ca docs: bump and reorder docs-requirements
- Bump max version of sphinx from <7 to <8
- Bump max version of myst-parser to <3
- Pinpoint sphinx-design to 0.5.0
- Properly group dependencies by type
2023-07-28 10:48:04 -07:00
bastimeyer e44a14313d docs: bump furo to 2023.03.27
- Bump docs build-dependencies
  - sphinx >=5.0.0, <7
  - myst-parser >=1.0.0, <2
  - sphinx-design >=0.4.1, <1
- Bump furo theme to latest version
- Fix theme build errors
2023-04-19 17:29:08 -07:00
bastimeyer 948160087e docs: rewrite, fix and improve CLI tutorial 2023-02-12 12:15:02 -08:00
bastimeyer 2b88f0ad31 docs: bump furo theme version to 2022.09.15 2022-09-19 10:06:17 -07:00
bastimeyer cc455586c5 ci: lint sphinx extensions and setup.py 2022-06-23 09:35:00 -07:00
bastimeyer 1c1dbf4f88 docs: replace recommonmark with myst-parser 2022-06-19 17:23:54 -07:00
bastimeyer 9785bf26f1 docs: bump furo theme version to 2022.06.04.1
- Bump min version of Sphinx to 4.0.0
  This was already required by the previous version of furo
- Revert headline font sizes, font weights and margins to previous style
- Fix broken margin of version links in sidebar
- Override font style of pygments' "generic output"
- Add edit page button via new config option
2022-06-19 17:23:54 -07:00
bastimeyer cfb482cac7 build: upgrade versioningit to >=2.0.0, <3
and update deprecated version format strings:
https://github.com/jwodder/versioningit/blob/v2.0.0/CHANGELOG.md
2022-06-14 15:55:16 -07:00
bastimeyer 487d529a2d ci: fix netlify PR preview builds
- Add versioningit to docs-requirements.txt
  Needed dependency when Streamlink was installed in editable mode.
- Reformat netlify.toml
- Update PYTHON_VERSION env var (based on Ubuntu 20.04)
- Always fetch all tags to ensure correct version strings in docs builds
- Add plugins dir to ignore check
2022-04-17 22:14:33 -07:00
bastimeyer 66c0c45f75 docs: bump furo docs req to 2021.09.08
- upgrade furo to 2021.09.08
- fix/restore custom theme overrides
2021-09-10 05:19:59 +00:00
bastimeyer afb11a470c docs: bump furo docs req to 2020.12.28.beta23 2020-12-30 11:41:13 +01:00
bastimeyer 81a4dd70e9 docs: switch theme to furo, bump sphinx to >=3.0
pinpoint furo to `2020.12.09.beta21` for now
2020-12-10 11:57:53 -08:00
Alexis Murzeau 3561be7311 docs: use recommonmark as an extension
Sphinx v1.8 has deprecated source_parsers which is used for recommonmark.

This commit replace the use of source_parsers for recommonmark with the
use of recommonmark as an extension (supported by recommonmark since
0.5.0).
2020-09-26 00:16:07 +02:00
beardypig deffd929d1 Change log as markdown refactor (#1667)
* rename CHANGELOG to md

* symlink the change log in to the docs

* include the recommonmark parser for md file

* reformatted the CHANGELOG md file, should look more or less the same as the RST

* refactored the release scripts to handle/generate the new format

* file is a bad variable name

* couple of minor tweaks, mainly style

* Fix git shortlog being highlighted as Python in the docs

* update manifest to include changelog.md instead of rst
2018-05-28 16:15:12 -07:00
beardypig 26f1c433e8 docs: pin sphinx to 1.6.+ so that no future changes affect the docs 2017-05-22 11:49:42 +01:00
beardypig 5deb3413a8 docs: tweaks to docs and docs build process
Minor tweaks to the docs. Fixed all the warnings and enabled "Fail on warning" option so that problems with the docs will cause the build to fail on warning, the docs are also built for every commit and PR.
Restructured the travis script/after_success so that the docs are only pushed if the build was successful (only master branch and no PRs).
2017-01-16 11:52:14 +00:00