diff --git a/CHANGELOG.md b/CHANGELOG.md index f776632..7b49824 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -27,5 +27,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - 73% test coverage with 90 tests - CI/CD workflows for testing, documentation, and package building -[Unreleased]: https://github.com/gb119/bad_path/compare/v0.1.0...HEAD -[0.1.0]: https://github.com/gb119/bad_path/releases/tag/v0.1.0 +[Unreleased]: https://github.com/stonerlab/bad_path/compare/v0.1.0...HEAD +[0.1.0]: https://github.com/stonerlab/bad_path/releases/tag/v0.1.0 diff --git a/README.md b/README.md index 795405d..f9589a4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # bad_path -[![Tests](https://github.com/gb119/bad_path/actions/workflows/tests.yml/badge.svg)](https://github.com/gb119/bad_path/actions/workflows/tests.yml) -[![Documentation](https://github.com/gb119/bad_path/actions/workflows/docs.yml/badge.svg)](https://gb119.github.io/bad_path/) +[![Tests](https://github.com/stonerlab/bad_path/actions/workflows/tests.yml/badge.svg)](https://github.com/stonerlab/bad_path/actions/workflows/tests.yml) +[![Documentation](https://github.com/stonerlab/bad_path/actions/workflows/docs.yml/badge.svg)](https://stonerlab.github.io/bad_path/) [![PyPI version](https://badge.fury.io/py/bad-path.svg)](https://badge.fury.io/py/bad-path) [![Anaconda Version](https://anaconda.org/phygbu/bad_path/badges/version.svg)](https://anaconda.org/phygbu/bad_path/badges/version.svg) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/68df7b8d1d044f17887b7d0df56b4aef)](https://app.codacy.com/gh/stonerlab/bad_path/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) @@ -34,7 +34,7 @@ mamba install -c phygbu bad_path ### From Source ```bash -git clone https://github.com/gb119/bad_path.git +git clone https://github.com/stonerlab/bad_path.git cd bad_path pip install -e . ``` @@ -248,7 +248,7 @@ def handle_user_file_request(user_path): ## Documentation -Full documentation is available at [https://gb119.github.io/bad_path/](https://gb119.github.io/bad_path/) +Full documentation is available at [https://stonerlab.github.io/bad_path/](https://stonerlab.github.io/bad_path/) ## Development diff --git a/conda.recipe/meta.yaml b/conda.recipe/meta.yaml index 1e559c8..a1ac28d 100644 --- a/conda.recipe/meta.yaml +++ b/conda.recipe/meta.yaml @@ -33,7 +33,7 @@ test: - pip about: - home: https://github.com/gb119/bad_path + home: https://github.com/stonerlab/bad_path license: MIT license_family: MIT license_file: LICENSE @@ -41,8 +41,8 @@ about: description: | bad_path provides functions to test whether a supplied file path points to a system-sensitive location, taking into account different OS platforms. - doc_url: https://gb119.github.io/bad_path/ - dev_url: https://github.com/gb119/bad_path + doc_url: https://stonerlab.github.io/bad_path/ + dev_url: https://github.com/stonerlab/bad_path extra: recipe-maintainers: diff --git a/docs/_static/StonerLogo2.png b/docs/_static/StonerLogo2.png new file mode 100644 index 0000000..cb47122 Binary files /dev/null and b/docs/_static/StonerLogo2.png differ diff --git a/docs/conf.py b/docs/conf.py index c18ab50..44888b6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,6 +12,10 @@ # Import version from package from bad_path import __version__ +# Add sphinx-better-theme to the path +import better +html_theme_path = [better.better_theme_path] + # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information @@ -37,9 +41,19 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = 'sphinx_rtd_theme' +html_theme = 'better' html_static_path = ['_static'] +# Theme options for sphinx-better-theme +html_theme_options = { + 'rightsidebar': False, + 'inlinecss': '', + 'linktotheme': False, +} + +# Use organization logo +html_logo = '_static/StonerLogo2.png' + # -- Options for intersphinx extension --------------------------------------- # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration diff --git a/docs/installation.rst b/docs/installation.rst index 7948372..abc5d23 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -38,7 +38,7 @@ To install the latest development version from GitHub: .. code-block:: bash - git clone https://github.com/gb119/bad_path.git + git clone https://github.com/stonerlab/bad_path.git cd bad_path pip install -e . diff --git a/pyproject.toml b/pyproject.toml index 1a0c119..095a0d8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -32,15 +32,15 @@ dev = [ "pytest>=7.0", "pytest-cov>=4.0", "sphinx>=7.0", - "sphinx-rtd-theme>=1.3", + "sphinx-better-theme>=0.1.5", "ruff>=0.1.0", ] [project.urls] -Homepage = "https://github.com/gb119/bad_path" -Documentation = "https://gb119.github.io/bad_path/" -Repository = "https://github.com/gb119/bad_path" -Issues = "https://github.com/gb119/bad_path/issues" +Homepage = "https://github.com/stonerlab/bad_path" +Documentation = "https://stonerlab.github.io/bad_path/" +Repository = "https://github.com/stonerlab/bad_path" +Issues = "https://github.com/stonerlab/bad_path/issues" [tool.setuptools.packages.find] where = ["."]