Skip to content

Commit e73cc8d

Browse files
jonasvddNielsPraet
jonasvdd
and
NielsPraet
authored
Docs/versioned docs (#236) (#237)
* Docs/versioned docs (#236) * 🔧 build: add mkdocs to project * 📝 docs: rewrite getting started page to mkdocs structure note: mkdocstrings still has to be added to support linking to library code * 📝 docs: translate dash app integration page to mkdocs structure * 📝 docs: translate FAQ page to mkdocs structure * 🔧 build: add mkdocstrings dependency * 🔧 build: add mkdocs-gen-files dependency * 🔧 build: add automatic code API reference page creation * 📝 docs: fix links to API documentation * 📝 build: add mkdocs-section-index * 📝 docs: fix registering documentation * 📝 docs: fix docs for figure_resampler dir * 📝 docs: fix aggregation documentation * 📝 docs: add versioning to documentation * 🔥 chore: remove old documentation * 👷 build: add mkdocs CI/CD step * 🔧 build: add QOL docs extensions * 📝 docs: add buttons for github, PyPi and DOI * ➖ chore: remove old sphinx dependencies * 🎨 chore: format code documentation * ✏️ chore: remove random text in docstring * 🎨 chore: format code * 👷 build: replace tag push with PR push * Docs/versioned docs (#238) * 🔧 build: add mkdocs to project * 📝 docs: rewrite getting started page to mkdocs structure note: mkdocstrings still has to be added to support linking to library code * 📝 docs: translate dash app integration page to mkdocs structure * 📝 docs: translate FAQ page to mkdocs structure * 🔧 build: add mkdocstrings dependency * 🔧 build: add mkdocs-gen-files dependency * 🔧 build: add automatic code API reference page creation * 📝 docs: fix links to API documentation * 📝 build: add mkdocs-section-index * 📝 docs: fix registering documentation * 📝 docs: fix docs for figure_resampler dir * 📝 docs: fix aggregation documentation * 📝 docs: add versioning to documentation * 🔥 chore: remove old documentation * 👷 build: add mkdocs CI/CD step * 🔧 build: add QOL docs extensions * 📝 docs: add buttons for github, PyPi and DOI * ➖ chore: remove old sphinx dependencies * 🎨 chore: format code documentation * ✏️ chore: remove random text in docstring * 🎨 chore: format code * 👷 build: replace tag push with PR push * 👷 build: fix mike deployment * Docs/versioned docs (#239) * 🔧 build: add mkdocs to project * 📝 docs: rewrite getting started page to mkdocs structure note: mkdocstrings still has to be added to support linking to library code * 📝 docs: translate dash app integration page to mkdocs structure * 📝 docs: translate FAQ page to mkdocs structure * 🔧 build: add mkdocstrings dependency * 🔧 build: add mkdocs-gen-files dependency * 🔧 build: add automatic code API reference page creation * 📝 docs: fix links to API documentation * 📝 build: add mkdocs-section-index * 📝 docs: fix registering documentation * 📝 docs: fix docs for figure_resampler dir * 📝 docs: fix aggregation documentation * 📝 docs: add versioning to documentation * 🔥 chore: remove old documentation * 👷 build: add mkdocs CI/CD step * 🔧 build: add QOL docs extensions * 📝 docs: add buttons for github, PyPi and DOI * ➖ chore: remove old sphinx dependencies * 🎨 chore: format code documentation * ✏️ chore: remove random text in docstring * 🎨 chore: format code * 👷 build: replace tag push with PR push * 👷 build: fix mike deployment * Docs/versioned docs (#240) * 🔧 build: add mkdocs to project * 📝 docs: rewrite getting started page to mkdocs structure note: mkdocstrings still has to be added to support linking to library code * 📝 docs: translate dash app integration page to mkdocs structure * 📝 docs: translate FAQ page to mkdocs structure * 🔧 build: add mkdocstrings dependency * 🔧 build: add mkdocs-gen-files dependency * 🔧 build: add automatic code API reference page creation * 📝 docs: fix links to API documentation * 📝 build: add mkdocs-section-index * 📝 docs: fix registering documentation * 📝 docs: fix docs for figure_resampler dir * 📝 docs: fix aggregation documentation * 📝 docs: add versioning to documentation * 🔥 chore: remove old documentation * 👷 build: add mkdocs CI/CD step * 🔧 build: add QOL docs extensions * 📝 docs: add buttons for github, PyPi and DOI * ➖ chore: remove old sphinx dependencies * 🎨 chore: format code documentation * ✏️ chore: remove random text in docstring * 🎨 chore: format code * 👷 build: replace tag push with PR push * 👷 build: fix mike deployment * 👷 build: fix git gh-pages fetching * 🖍️ review * 👷 build: create docs on tag push --------- Co-authored-by: Niels Praet <[email protected]> Co-authored-by: Niels Praet <[email protected]>
1 parent 2125b66 commit e73cc8d

40 files changed

+1315
-1351
lines changed

‎.github/deploy-gh-pages.sh

-34
This file was deleted.

‎.github/workflows/deploy-docs.yml

-40
This file was deleted.

‎.github/workflows/deploy-mkdocs.yml

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Deploy docs
2+
3+
on:
4+
push:
5+
tags:
6+
- "*"
7+
8+
jobs:
9+
deploy:
10+
name: Deploy
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout repo
15+
uses: actions/checkout@v3
16+
17+
- name: Set up Python
18+
uses: actions/setup-python@v4
19+
with:
20+
python-version: 3.8
21+
22+
- name: Install Poetry
23+
uses: snok/install-poetry@v1
24+
25+
- name: Cache Poetry
26+
id: cached-poetry-dependencies
27+
uses: actions/cache@v3
28+
with:
29+
path: ~/.cache/pypoetry/virtualenvs
30+
key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}-python-3.8
31+
32+
- run: poetry --version
33+
34+
- name: Install dependencies
35+
run: poetry install
36+
37+
- name: fetch from gh-pages
38+
run: git fetch origin gh-pages --depth=1
39+
40+
- name: Configure Git user
41+
run: |
42+
git config --local user.email "github-actions[bot]@users.noreply.github.com"
43+
git config --local user.name "github-actions[bot]"
44+
45+
- name: Deploy with mike
46+
run: |
47+
poetry run mike deploy -b gh-pages --update-aliases --push "${{ github.ref_name }}" "latest"

‎docs/sphinx/FAQ.rst

-188
This file was deleted.

‎docs/sphinx/Makefile

-20
This file was deleted.

‎docs/sphinx/aggregation.rst

-55
This file was deleted.

0 commit comments

Comments
 (0)