diff --git a/docs/_static/logo.svg b/docs/_static/logo.svg new file mode 100644 index 00000000..4e5ad28d --- /dev/null +++ b/docs/_static/logo.svg @@ -0,0 +1,721 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/architecture.rst b/docs/architecture.rst index db918019..3cdd9932 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -12,8 +12,8 @@ Packages have strict rules of importing: Full dependency diagram: -.. image:: ahriman-architecture.svg - :target: _images/ahriman-architecture.svg +.. image:: _static/architecture.svg + :target: _static/architecture.svg :alt: architecture ``ahriman.application`` package diff --git a/docs/conf.py b/docs/conf.py index 5c6053d6..29a9fee6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -72,7 +72,9 @@ html_theme = "sphinx_rtd_theme" # 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, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = [] +html_static_path = ["_static"] + +html_logo = "_static/logo.svg" add_module_names = False diff --git a/tox.ini b/tox.ini index 17a7c3ab..7ce5104a 100644 --- a/tox.ini +++ b/tox.ini @@ -55,7 +55,7 @@ commands = bash -c 'shtab --shell bash --prefix ahriman --prog ahriman ahriman.application.ahriman._parser > ../package/share/bash-completion/completions/_ahriman' bash -c 'shtab --shell zsh --prefix ahriman --prog ahriman ahriman.application.ahriman._parser > ../package/share/zsh/site-functions/_ahriman' argparse-manpage --module ahriman.application.ahriman --function _parser --author "ahriman team" --project-name ahriman --author-email "" --url https://github.com/arcan1s/ahriman --output ../package/share/man/man1/ahriman.1 - pydeps ahriman -o ../docs/ahriman-architecture.svg --no-config --no-show --cluster + pydeps ahriman -o ../docs/_static/architecture.svg --no-config --no-show --cluster # remove autogenerated modules rst files find ../docs -type f -name "{[tox]project_name}*.rst" -delete sphinx-apidoc -o ../docs . @@ -78,7 +78,7 @@ allowlist_externals = passenv = SSH_AUTH_SOCK commands = - git add package/archlinux/PKGBUILD src/ahriman/__init__.py docs/ahriman-architecture.svg package/share/man/man1/ahriman.1 package/share/bash-completion/completions/_ahriman package/share/zsh/site-functions/_ahriman + git add package/archlinux/PKGBUILD src/ahriman/__init__.py docs/_static/architecture.svg package/share/man/man1/ahriman.1 package/share/bash-completion/completions/_ahriman package/share/zsh/site-functions/_ahriman git commit -m "Release {posargs}" git tag "{posargs}" git push