diff --git a/docs/conf.py b/docs/conf.py index ab7cd47..8f58738 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -130,8 +130,15 @@ # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -# -html_theme_options = {"show_nav_level": 2} + +html_theme_options = { + "show_nav_level": 2, + "logo": { + "text": "AstroDB Toolkit", + "image_light": "_static/Toolkit-logo.png", + "image_dark": "_static/Toolkit-logo.png", + } +} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/pages/dev_docs/developer_installation.rst b/docs/pages/dev_docs/developer_installation.rst index 98cca4f..d998a88 100644 --- a/docs/pages/dev_docs/developer_installation.rst +++ b/docs/pages/dev_docs/developer_installation.rst @@ -1,16 +1,27 @@ Developer Documentation ======================= +.. toctree:: + :glob: + :maxdepth: 2 + :titlesonly: + + documentation + ingest_functions + + Installation ------------ -If you'd like to run tests, make sure to install the package with the optional test dependencies. E.g., +If you'd like to run tests, make sure to install the package with the optional +test dependencies. E.g., .. code-block:: bash pip install -e ".[test]" -Make sure you get the `astrodb-template-db`` submodule. This is required for running tests and building the documentation. +Make sure you get the `astrodb-template-db`` submodule. This is required for +running tests and building the documentation. .. code-block:: bash @@ -28,10 +39,9 @@ All contributions should include tests. To run the tests, use the command Linting and Formatting ---------------------- ----------------------- -Use `ruff `_ for linting and formatting. -A pre-commit hook is provided for automatic linting and formatting with ruff. +Use `ruff `_ for linting and formatting. +A pre-commit hook is provided for automatic linting and formatting with ruff. To use it, run `pip install pre-commit` and then `pre-commit install --allow-missing-config`. VSCode setup instructions: `Formatting Python in VSCode `_