Skip to content

Commit

Permalink
Fix issue with mike redirects
Browse files Browse the repository at this point in the history
  • Loading branch information
oashour committed May 3, 2024
1 parent 2d8d14e commit 02892b4
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 9 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/release_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,6 @@ jobs:
git config --global user.name "Docs Deploy"
git config --global user.email "docs.deploy@example.co.uk"
- name: Build Docs Website
run: mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest
run:
mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest
mike set-default --push latest
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ MnO_Magnon.py
VBT.vasp
VBTS_mdm.h5
hcp_He_lsm.h5
venv/**
8 changes: 8 additions & 0 deletions docs/overrides/main.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{% extends "base.html" %}

{% block outdated %}
You're not viewing the latest version.
<a href="{{ '../' ~ base_url }}">
<strong>Click here to go to latest.</strong>
</a>
{% endblock %}
24 changes: 16 additions & 8 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@ build-backend = "setuptools.build_meta"
[project]
name = "dark-magic"
version = "0.0.1"
authors = [
{ name="Omar A. Ashour", email="ashour@berkeley.edu" },
]
authors = [{ name = "Omar A. Ashour", email = "ashour@berkeley.edu" }]
description = "Dark Matter Ab initio maGnon/phonon Interaction Calculator (DarkMAGIC) is a python package for computing DM interaction rates with collective excitations based on ab initio calculations of material properties."
readme = "README.md"
requires-python = ">=3.10"
Expand All @@ -17,9 +15,9 @@ dependencies = [
"rad-tools",
"h5py",
"mpi4py",
"setuptools",
"setuptools; python_version=='3.12'",
]
classifiers=[
classifiers = [
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
Expand All @@ -35,8 +33,18 @@ classifiers=[
Homepage = "https://github.com/Griffin-Group/DarkMAGIC"
Issues = "https://github.com/Griffin-Group/DarkMAGIC/issues"

[project.optional-dependencies]
docs = [ # Optional dependencies for building documentation
"mkdocs-material",
"mike",
"mkdocstrings",
"mkdocstrings-python",
"mkdocs-literate-nav",
"mkdocs-gen-files",
"mkdocs-section-index",
]
[tool.setuptools.packages]
find = {} # Scan the project directory with the default parameters
find = {} # Scan the project directory with the default parameters

[tool.ruff]
# Exclude a variety of commonly ignored directories.
Expand Down Expand Up @@ -74,8 +82,8 @@ exclude = [
line-length = 88
indent-width = 4

# Assume Python 3.8
target-version = "py38"
# Assume Python 3.10
target-version = "py310"

[tool.ruff.lint]
# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default.
Expand Down

0 comments on commit 02892b4

Please sign in to comment.