Merge pull request #4960 from JOJ0/docs_logo

This commit is contained in:
J0J0 Todos 2023-10-23 13:48:20 +02:00 committed by GitHub
commit 894039d000
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 41 additions and 16 deletions

View file

@ -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? Wed love to
hear about it! Submit a post to our `our
forums <https://discourse.beets.io/>`__ under the “Show and Tell”
category for a chance to get featured in `the
hear about it! Submit a post to our `discussion board
<https://github.com/beetbox/beets/discussions/categories/show-and-tell>`__
under the “Show and Tell” category for a chance to get featured in `the
docs <https://beets.readthedocs.io/en/stable/guides/advanced.html>`__.
- Consider helping out in `our forums <https://discourse.beets.io/>`__
by responding to support requests or driving some new discussions.
- Consider helping out fellow users by by `responding to support requests
<https://github.com/beetbox/beets/discussions/categories/q-a>`__ .
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 <http://makeapullrequest.com/>`__, or stop by our
`forums <https://discourse.beets.io/>`__ if you have any questions.
`discussion board <https://github.com/beetbox/beets/discussions/>`__
if you have any questions.
We maintain a list of issues we reserved for those new to open source
labeled `“first timers

View file

@ -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
-------

View file

@ -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/

12
docs/_static/beets.css vendored Normal file
View file

@ -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 */

BIN
docs/_static/beets_logo.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

View file

@ -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']

View file

@ -6,7 +6,7 @@ Got a question that isn't answered here? Try the `discussion board`_, or
:ref:`filing an issue <bugs>` 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:

View file

@ -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/

View file

@ -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
--------

View file

@ -132,7 +132,7 @@ setup(
],
"docs": [
"sphinx",
"sphinx_rtd_theme",
"pydata_sphinx_theme",
],
# Plugin (optional) dependencies:
"absubmit": ["requests"],

View file

@ -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