diff --git a/.github/workflows/generate.yml b/.github/workflows/generate.yml index 74b08fe..99f991e 100644 --- a/.github/workflows/generate.yml +++ b/.github/workflows/generate.yml @@ -147,38 +147,6 @@ jobs: if [[ $(git ls-remote --heads origin generate | wc -l) -eq 1 ]]; then git push origin --delete generate fi - publish: - runs-on: ubuntu-latest - needs: generate - steps: - - name: Checkout - uses: actions/checkout@v4 - with: - token: ${{ secrets.GH_TOKEN || secrets.GITHUB_TOKEN }} - fetch-depth: 0 - submodules: 'recursive' - - name: Install uv - uses: astral-sh/setup-uv@v4 - with: - enable-cache: true - cache-dependency-glob: "uv.lock" - - name: "Submodule fetching" - continue-on-error: true - if: ${{inputs.SUBMODULE}} - run: | - git submodule update --init --recursive --checkout -f --remote -- "docs" - git config --global user.name "GitHub Action" - git config --global user.email "noreply@github.com" - git commit -am "chore (update): fetch submodule" - git push - - name: Setup Python - uses: actions/setup-python@v5 - with: - python-version: '3.13' - cache: "pip" - - name: Install dependencies - run: uv sync --no-dev - - name: Build - run: | - uv run mkdocs gh-deploy --force + + \ No newline at end of file diff --git a/README.md b/README.md index 932c68b..657e01b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ - Python 3.12 or higher - [uv](https://docs.astral.sh/uv/) +> [!warning] +> As Netlify doesn't support Python past 3.8, the template **can't** be used with Netlify. +> Only GitHub Page is officially supported. + # Installation 1. Click on "use this template" 2. Create the new repository from the template @@ -10,4 +14,13 @@ - Click on "New repository secret" - Name: `GH_TOKEN` - Value: `` -5. In "Actions" tab, click on "generate website" and fill the information needed \ No newline at end of file +5. While in Settings, go to "Pages" and select "Deploy from a branch" and select `gh-pages` branch (from root) +> [!Warning] You can publish a private repository as a public page in the free tier of GitHub. But you can use a private submodule as your docs folder and publish it as a public page. + +# Template generation + +1. In Actions, go "Generate Website" and click on "Run workflow". +2. Fill the items and click on "Run workflow" +3. Wait for the workflow to finish +4. Read and validate the pull request, merge it. +5. You can now go into "Publish" and click on "Run workflow" to publish the website. \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 6a260ec..76af697 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,7 +17,9 @@ dependencies = [ "mkdocs-custom-tags-attributes", "mkdocs-meta-descriptions-plugin", "mkdocs-glightbox", - "mkdocs-obsidian-links" + "mkdocs-obsidian-links", + "beautifulsoup4", + "babel" ] [tool.ruff.lint]