patrick96
baed54bc76
doc: Improve tray documentation
...
Unaware users may be confused by why the tray module is not shown in the
default config and if they add it, they may be confused why only one of
their bars shows the module.
2024-08-01 11:09:46 +02:00
patrick96
0ed669f049
fix(doc): Update vulnerable rtd search extension
...
Ref: https://github.com/readthedocs/readthedocs-sphinx-search/security/advisories/GHSA-xgfm-fjx6-62mj
2024-01-20 17:53:28 +01:00
patrick96
2471f3595c
Version 3.7.0
2023-11-05 23:36:13 +01:00
patrick96
cd57c1252c
Write migration guide for the content in custom/text
2023-11-05 22:53:09 +01:00
patrick96
ea3b47a65e
Improve release workflow documentation
2023-11-05 22:05:43 +01:00
patrick96
70c400d20d
doc: Specify boxes to check in GitHub release tool
2023-11-05 22:05:43 +01:00
patrick96
0a19c5e3d7
doc: Bump sphinx-rtd-theme to version 2
...
The notfound plugin (404 page) does not seem to work with older versions
of the theme.
2023-10-23 01:08:14 +02:00
patrick96
eaa3ba5f83
doc: Fix sphinx version
2023-10-23 00:32:46 +02:00
patrick96
38f67f4269
doc: Add sphinx 404 page
2023-10-23 00:32:46 +02:00
patrick96
054b9f4d33
docs: Add banner for 'latest' version
2023-10-23 00:32:46 +02:00
patrick96
278584fa27
feat(doc): Add rtd search extension
...
Provides real-time search on readthedocs
Ref: https://readthedocs-sphinx-search.readthedocs.io
2023-10-08 21:24:37 +02:00
patrick96
19e8d53320
doc: Explicitly specify sphinx rtd theme dependency
...
Since August 7, 2023, readthedocs will not install the rtd theme by
default anymore.
Ref: https://blog.readthedocs.com/python-core-requirements-changed/
2023-10-08 21:16:21 +02:00
patrick96
1bfe117c5d
Document recommendations for nerd fonts
2023-09-30 19:32:48 +02:00
patrick96
97ce1f6e7a
Add inactive tray module to default config
...
Replaces the commented out `tray-position`
2023-08-06 15:26:28 +02:00
patrick96
7bc673b8f2
fix(doc): %s in extlinks caption before sphinx 4.0
...
There is no way to support extlinks with a custom caption in both sphinx
< 4 and >= 4 at the same time without implementing different behavior
per version.
2023-04-20 01:24:02 +02:00
patrick96
89ca0255f1
doc: Fix extlinks %s substitution in caption
...
Substitutions in the caption are only supported in version 4 of
sphinx.
However, RTD uses sphinx 1.8.6
Just letting it append the value seems to work in both 1.8.6 and newer
versions.
2023-04-18 15:48:38 +02:00
patrick96
cf802ad431
doc: Mention errors and warnings in migration guide
2023-04-18 15:48:38 +02:00
patrick96
dbac7d8ae8
doc: Finish tray migration guide
2023-04-18 15:48:38 +02:00
patrick96
fcef90be24
doc: Start tray migration guide
2023-04-18 15:48:38 +02:00
patrick96
6148bb7f14
doc: Add empty migration page
2023-04-18 15:48:38 +02:00
patrick96
30bb1584fc
doc: Add page about default config
2023-04-18 15:48:38 +02:00
patrick96
f3c911991c
doc: Document custom directive in python script
2023-04-18 15:48:38 +02:00
patrick96
44b5f87884
doc: Use issue directive to link to issue
2023-04-18 15:48:38 +02:00
patrick96
006e971dad
doc: Add module links
2023-04-18 15:48:38 +02:00
patrick96
6e0cff97ff
doc(tray): Add type at the beginning
2023-04-18 15:48:38 +02:00
patrick96
fc422b1107
doc: Style external links in RTD theme
2023-04-18 15:48:38 +02:00
patrick96
81684a6c9d
doc: Show version in alabaster theme (local builds)
2023-04-18 15:48:38 +02:00
patrick96
0032f27686
doc: Use extlinks for linking to issues and PRs
2023-04-18 15:48:38 +02:00
patrick96
234e606b41
doc: Replace custom domain with add_object_type
...
Less overhead and doesn't require a new dependency
2023-04-18 15:48:38 +02:00
patrick96
c48aa1998c
fix(doc): Setup function not always running
...
If the sphinx version was below 1.8.5, no setup function was defined at
all.
2023-04-18 15:48:38 +02:00
patrick96
98d58b6f27
doc: Reformat conf.py
2023-04-18 15:48:38 +02:00
patrick96
c6eb3f88ea
doc(tray): Initial experiments
2023-04-18 15:48:38 +02:00
Patrick Ziegler
918bc212ee
doc: Remove sphinx language setting ( #2822 )
...
Sphinx now emits a warning if `language` is set to `None`
2022-09-19 22:49:03 +02:00
Patrick Ziegler
1ee11f7c9e
Adapt release workflow to produce signed releases ( #2720 )
2022-05-09 17:00:14 +02:00
Patrick Ziegler
1f55eaf73d
Adapt to official Arch Linux package ( #2719 )
...
Now that polybar is in the official repos, we only need the polybar-git
PKGBUILD.
2022-05-09 16:36:54 +02:00
Patrick Ziegler
f0dbb4cc63
Add darkmode banner ( #2712 )
...
Ref #2706
2022-05-04 21:31:25 +02:00
patrick96
7a1824a9b9
Merge remote-tracking branch 'origin/hotfix/3.6.3'
2022-05-04 11:08:12 +02:00
Patrick Ziegler
4f923ededc
doc: Fix menu module action migration example ( #2687 )
...
The label-open was missing, making the snippet not work as-is.
In addition, backgrounding programs is no longer necessary
Ref #2686
2022-04-13 10:47:01 +02:00
patrick96
8363b20793
doc: Disable collapse_navigation in rtd_theme
2022-04-03 14:32:15 +02:00
patrick96
80173c6413
Add section about distro specific setups
2022-04-03 14:32:15 +02:00
patrick96
61c4976bb5
doc: Add getting started for developers
2022-04-03 14:32:15 +02:00
patrick96
e1856cf8ec
Move testing page to repo
2022-04-03 14:32:15 +02:00
patrick96
f6651d58d0
Move style guide to repo
2022-04-03 14:32:15 +02:00
patrick96
39a640d5d0
Move banner to doc folder
2022-03-13 21:26:54 +01:00
patrick96
b04f636bab
doc: Mention XDG_RUNTIME_DIR for IPC
2022-03-05 13:59:27 +01:00
Samuel Henrique
40cbe7ed97
Skip manpage and html doc installation if they weren't generated
...
Otherwise we get errors like this:
CMake Error at doc/cmake_install.cmake:46 (file):
file INSTALL cannot find
"/<<PKGBUILDDIR>>/build/doc/html": No such file or
directory.
Call Stack (most recent call first):
cmake_install.cmake:59 (include)
2022-03-02 23:46:46 +01:00
patrick96
4350e356a7
Documentation update for 3.6
2022-03-02 14:58:49 +01:00
patrick96
fce5c4445f
Release 3.6.0
2022-02-26 21:42:34 +01:00
patrick96
f1490a13ca
Use points in default config
...
Allows people to better scale by setting the dpi
2022-02-25 04:38:07 +01:00
Michał Górny
a33e8de922
doc: Defer parsing version_txt to fix an obscure bug
...
Defer parsing the version read from version.txt until it's about
to be used, in order to fix an obscure bug involving indirect
pkg_resources.
When pkg_resources are imported, they override packaging with their own
pkg_resources.extern.packaging. Depending on the system, this could
either wrap the vendored pkg_resources._vendor.packaging or system
packaging. For some reason, in the latter case the Version objects
created prior to the wrapping are incompatible with the objects created
afterwards. This causes the doc build to fail with:
```
Exception occurred:
File "/tmp/polybar/build/doc/conf.py", line 249, in run
if directive_version > version_txt:
TypeError: '>' not supported between instances of 'Version' and 'Version'
```
This happens because apparently pkg_resources are imported indirectly
somewhere between conf.py processing and running VersionDirective.
Deferring version parsing until the latter guarantees that both objects
are constructed at the same point in program flow and therefore use
the same packaging package.
2022-01-31 01:20:18 +01:00