Commit Graph

23 Commits

Author SHA1 Message Date
bastimeyer 60fca3485a docs: update Windows builds flavors 2024-05-09 00:32:13 +02:00
bastimeyer 6cb3c023ab docs: fix scrollbars in sidebars 2024-02-12 14:03:18 +01:00
bastimeyer 5beda9470a docs: add icons to packages and install methods 2023-08-08 09:47:36 -07:00
bastimeyer 51b6ef6824 docs: use grid-cards for team-members 2023-02-18 10:51:54 +01:00
bastimeyer b1a580b4e2 docs: rewrite install page
- Add header grid-cards for quickly choosing the OS or PyPI package
- Rename "AppImages" section to "Linux AppImages"
- Greatly reduce noise in the "Windows binaries" and "Linux AppImages"
  sections by replacing texts and lists with grid-cards and tables,
  and remove "stable/nightly builds" sub-sections respectively
- Add SVG logos for Python and FFmpeg, obtained from original sources,
  with slight modifications and optimizations applied
- Move up "Dependencies" section by one level
- Rewrite some texts for better clarity and fix some grammar errors
- Upgrade font-awesome from 5 to 6
2023-02-17 19:59:33 -08:00
bastimeyer a0a5af60b0 docs: remove Open Collective
- Rewrite the documentation's donate page
  - Remove donation infos from individual team members
  - Add all team members
  - Fix GitHub username regex in Sphinx extension
- Rewrite the project README
  - Use HTML for centered text, add logo, update badges
  - Rephrase text sections
  - Remove Open Collective and update support section
- Replace all links to Open Collective with a link to the latest docs
2023-02-11 12:10:36 -08:00
bastimeyer 35799b03eb docs: add Open Graph metadata 2022-08-14 11:26:33 -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 3cf149f0c1 docs: update dependencies section in install docs 2022-05-01 21:24:20 -07:00
bastimeyer 3f613dad4b docs: update and fix donations page 2022-04-23 16:55:36 -07:00
bastimeyer ebe0d7a2cc docs: fix CLI argument line breaks 2022-04-01 19:56:51 -07:00
bastimeyer d24aaa76e4 docs: dynamically build list of plugins
Implement custom "plugins" sphinx extension which parses metadata from
plugin files and which outputs a list of plugins with datalists that
include the annotated metadata in addition to plugin arguments and
links to plugin files + issues on GitHub.

Add plugin metadata linting tests and remove old plugin matrix tests.
2022-03-03 20:33:30 -08:00
bastimeyer 98da60a783 docs: add icon to external links 2022-03-03 20:25:58 -08: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 3808688dfc cli: refactor CONFIG_FILES and PLUGIN_DIRS
- use pathlib.Path instead of strings
- rename PLUGINS_DIR to PLUGIN_DIRS and turn into list
- call expanduser() for all `--plugin-dirs` dirs
- reformat CLI docs
- fix tests
2021-06-06 11:50:33 -07:00
bastimeyer f62dd98e43 docs: add favicons and PWA manifest 2020-12-10 11:57:53 -08:00
bastimeyer 71cda12f67 docs: fix scrollbar issues in both sidebars
- theme issue workaround: set width of scrollbar content, so that the
  scrollbar doesn't shrink the available space once it appears
- theme issue workaround: add padding-right to TOC content, so that the
  text doesn't touch the scrollbar
- make TOC scrollbar transparent while not hovering it, as it's
  distracting otherwise on large TOC lists
2020-12-10 11:57:53 -08:00
bastimeyer e4268b7027 docs: fix applications and donate pages
- Add back font-awesome icons (and switch from v4 to v5)
- Add back Github avatar styles
2020-12-10 11:57:53 -08:00
bastimeyer a5af0d1be6 docs: add version warning message
and fix font sizes+weights of the admonition component
2020-12-10 11:57:53 -08:00
bastimeyer 5a2ae34965 docs: change/fix fonts, brand colors and spacings
- Use Streamlink's brand colors
- Add more names for Apple's San Francisco font to global font stack
- Remove 110% font-size media query on "large" screens
- Fix font-size of inline code elements
- Reduce height of main menu items by a bit
- Add back custom table styles used on the install page
- Fix style of :command: directive
- Fix font weight of active TOC item and add a little icon
2020-12-10 11:57:53 -08:00
bastimeyer 06952a89fe docs: add custom stylesheet and customize sidebar
- Add custom CSS stylesheet
- Fix sidebar brand+version section and add back the oneliner text
- Adjust logo and text sizes
- Add back stable/latest links and remember the current page
- Add back Github buttons below the main menu
2020-12-10 11:57:53 -08:00
Alexis Murzeau e95aaac6d9 docs: remove flattr-badge.png image
It was used in README.rst before, but is no longer used since commit
b4470f3e7c.

Also remove _static directory and its reference from docs/conf.py as it
only contains that image.
2017-12-29 00:58:48 +01:00
Christopher Rosell 03d9737753 Convert README.md to rst and add CONTRIBUTING.rst. 2013-10-09 02:29:41 +02:00