Skip to content

Commit

Permalink
fix api display in docs, automatic version bump for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AlbertDominguez committed Oct 7, 2024
1 parent 225732c commit ca8affd
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
8 changes: 5 additions & 3 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
name: documentation

on:
release:
workflow_run:
workflows: [tests]
types:
- published
- completed
workflow_dispatch:

permissions:
contents: write

jobs:
docs:
if: ${{ github.event.workflow_run.conclusion == 'success' }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
pip install sphinx sphinx-immaterial
pip install spotiflow[docs]
- name: Sphinx build
run: |
sphinx-build docs/source docs/build
Expand Down
6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
from pathlib import Path
import sys
sys.path.insert(0, Path(__file__).parents[2].resolve().as_posix())
from spotiflow import __version__ as __spotiflow_version__

project = 'Spotiflow'
copyright = '2023, Albert Dominguez Mantes'
copyright = '2024, Albert Dominguez Mantes'
author = 'Albert Dominguez Mantes'
release = '0.4.0'
release = __spotiflow_version__

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down

0 comments on commit ca8affd

Please sign in to comment.