Skip to content

Commit

Permalink
Update install doc
Browse files Browse the repository at this point in the history
- Fix html_static_path entry '_static' does not exist warning.
- Mention custom Python binary path feature
  • Loading branch information
xxyzz committed Jan 20, 2024
1 parent af2a438 commit 2bd539c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
3 changes: 1 addition & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "WordDumb"
copyright = "2023, xxyzz"
copyright = "2024, xxyzz"
author = "xxyzz"

# -- General configuration ---------------------------------------------------
Expand All @@ -23,7 +23,6 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "furo"
html_static_path = ["_static"]
html_logo = "../starfish.svg"
html_theme_options = {
"source_repository": "https://github.com/xxyzz/WordDumb",
Expand Down
4 changes: 3 additions & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ Use `Chocolatey <https://chocolatey.org>`_ or download from https://calibre-eboo
Install Python 3.11+ and pip
----------------------------

You could set the Python interpreter path in the plugin preferences window if you don't use the following methods to install Python.

- Arch Linux:

.. code-block:: console
Expand Down Expand Up @@ -69,7 +71,7 @@ Use Chocolatey or download from https://www.python.org/downloads
.. attention::
- Do not change the default installation settings in the Python installer.
- The dependencies(`PyTorch <https://pytorch.org/get-started/locally>`_) of the transformer model may not support the latest Python version.
- The dependencies(`PyTorch <https://pytorch.org/get-started/locally>`_) of the transformer model may not support the latest Python and CUDA version.


Install CUDA(optional)
Expand Down

0 comments on commit 2bd539c

Please sign in to comment.