diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d91966011..f5edb70f9 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -42,12 +42,12 @@ Non-Programming compiling a library of freely-licensed music files (preferably with incorrect metadata) for testing and measurement. - Think you have a nice config or cool use-case for beets? We’d love to - hear about it! Submit a post to our `our - forums `__ under the “Show and Tell” - category for a chance to get featured in `the + hear about it! Submit a post to our `discussion board + `__ + under the “Show and Tell” category for a chance to get featured in `the docs `__. -- Consider helping out in `our forums `__ - by responding to support requests or driving some new discussions. +- Consider helping out fellow users by by `responding to support requests + `__ . Programming ----------- @@ -119,7 +119,8 @@ If this is your first time contributing to an open source project, welcome! If you are confused at all about how to contribute or what to contribute, take a look at `this great tutorial `__, or stop by our -`forums `__ if you have any questions. +`discussion board `__ +if you have any questions. We maintain a list of issues we reserved for those new to open source labeled `“first timers diff --git a/README.rst b/README.rst index 42f770278..0813bd6cc 100644 --- a/README.rst +++ b/README.rst @@ -115,12 +115,11 @@ Contact you'd like to see prioritized over others. * Need help/support, would like to start a discussion, have an idea for a new feature, or would just like to introduce yourself to the team? Check out - `GitHub Discussions`_ or `Discourse`_! + `GitHub Discussions`_! .. _GitHub Discussions: https://github.com/beetbox/beets/discussions .. _issue tracker: https://github.com/beetbox/beets/issues .. _open a new ticket: https://github.com/beetbox/beets/issues/new/choose -.. _Discourse: https://discourse.beets.io/ Authors ------- diff --git a/README_kr.rst b/README_kr.rst index a6a95ec5a..c12fc8b71 100644 --- a/README_kr.rst +++ b/README_kr.rst @@ -104,5 +104,5 @@ Read More `Adrian Sampson`_ 와 많은 사람들의 지지를 받아 Beets를 만들었다. 돕고 싶다면 `forum`_.를 방문하면 된다. -.. _forum: https://discourse.beets.io +.. _forum: https://github.com/beetbox/beets/discussions/ .. _Adrian Sampson: https://www.cs.cornell.edu/~asampson/ diff --git a/docs/_static/beets.css b/docs/_static/beets.css new file mode 100644 index 000000000..243ae74cc --- /dev/null +++ b/docs/_static/beets.css @@ -0,0 +1,12 @@ +html[data-theme="light"] { + --pst-color-secondary: #a23632; +} +html[data-theme="light"] { + --pst-color-inline-code: #a23632; +} + +/* beetroot red: #a23632 */ +/* beetroot green: #1B5801 */ +/* beetroot green light: rgb(27, 150, 50) */ +/* pydata teal (primary): #126A7E */ +/* pydata violet (secondary): #7D0E70 */ diff --git a/docs/_static/beets_logo.png b/docs/_static/beets_logo.png new file mode 100644 index 000000000..0359260ad Binary files /dev/null and b/docs/_static/beets_logo.png differ diff --git a/docs/conf.py b/docs/conf.py index 4514bbe2b..0220ab48b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -59,5 +59,16 @@ man_pages = [ ), ] -# Options for Alabaster theme -html_theme_options = {"fixed_sidebar": True} +# Options for pydata theme +html_theme = 'pydata_sphinx_theme' +html_theme_options = { + 'collapse_navigation': True, + "logo": { + "text": "beets", + }, + "pygment_light_style": "bw", +} +html_title = "beets" +html_logo = "_static/beets_logo.png" +html_static_path = ['_static'] +html_css_files = ['beets.css'] diff --git a/docs/faq.rst b/docs/faq.rst index 814f87b7a..44c8fa25c 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -6,7 +6,7 @@ Got a question that isn't answered here? Try the `discussion board`_, or :ref:`filing an issue ` in the bug tracker. .. _mailing list: https://groups.google.com/group/beets-users -.. _discussion board: https://discourse.beets.io +.. _discussion board: https://github.com/beetbox/beets/discussions/ .. contents:: :local: diff --git a/docs/guides/tagger.rst b/docs/guides/tagger.rst index d47ee3c4a..68ad908e8 100644 --- a/docs/guides/tagger.rst +++ b/docs/guides/tagger.rst @@ -309,4 +309,4 @@ If we haven't made the process clear, please post on `the discussion board`_ and we'll try to improve this guide. .. _the mailing list: https://groups.google.com/group/beets-users -.. _the discussion board: https://discourse.beets.io +.. _the discussion board: https://github.com/beetbox/beets/discussions/ diff --git a/docs/index.rst b/docs/index.rst index 961c0f42d..2ad2fca06 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,7 +20,7 @@ where you think this documentation can be improved. .. _beets: https://beets.io/ .. _the mailing list: https://groups.google.com/group/beets-users .. _file a bug: https://github.com/beetbox/beets/issues -.. _the discussion board: https://discourse.beets.io +.. _the discussion board: https://github.com/beetbox/beets/discussions/ Contents -------- diff --git a/setup.py b/setup.py index c96f1fe24..e55a48e17 100755 --- a/setup.py +++ b/setup.py @@ -132,7 +132,7 @@ setup( ], "docs": [ "sphinx", - "sphinx_rtd_theme", + "pydata_sphinx_theme", ], # Plugin (optional) dependencies: "absubmit": ["requests"], diff --git a/tox.ini b/tox.ini index 4fa8d897c..fb0027177 100644 --- a/tox.ini +++ b/tox.ini @@ -33,7 +33,9 @@ commands = [testenv:docs] basepython = python3.10 -deps = sphinx<4.4.0 +deps = + sphinx<4.4.0 + pydata_sphinx_theme commands = sphinx-build -W -q -b html docs {envtmpdir}/html {posargs} # checks all links in the docs