Skip to content

Commit

Permalink
updated the install instructions (#584)
Browse files Browse the repository at this point in the history
  • Loading branch information
Josef-Haupt authored Feb 14, 2025
1 parent 752cd0c commit 50dd29a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
10 changes: 3 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@
copyright = "%Y, BirdNET-Team"
author = "Stefan Kahl"
version = "1.5.1"
html_favicon = "_static/birdnet-icon.ico"
html_logo = "_static/birdnet_logo.png"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand All @@ -36,14 +34,12 @@
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]


# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
import sphinx_rtd_theme

html_theme = "sphinx_rtd_theme"
html_favicon = "_static/birdnet-icon.ico"
html_logo = "_static/birdnet_logo.png"
html_static_path = ["_static"]
html_css_files = ["css/custom.css"]
html_theme_options = {
"style_external_links": True,
}
html_theme_options = {"style_external_links": True, "github_url": "https://github.com/kahst/BirdNET-Analyzer"}
9 changes: 8 additions & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,14 @@ Install the packages

.. code-block:: bash
pip install -r requirements.txt
pip install .
.. note::

If you also want to use the GUI, you need to install the additional packages with: ``pip install .[gui]``.
Same goes for server and training tools: ``pip install .[server]`` and ``pip install .[train]``.

Use ``pip install .[gui,server,train]`` to install all packages.

Verify the installation

Expand Down

0 comments on commit 50dd29a

Please sign in to comment.