Skip to content

Commit

Permalink
Switch documentation to Markdown & MkDocs.
Browse files Browse the repository at this point in the history 
Squashed commit of the following:

commit 7049179
Author: funilrys <[email protected]>
Date:   Sat Sep 21 21:10:22 2024 +0200

    pylint: ignore too-many-positional-arguments

commit dd4ba38
Merge: c9d246e 93ec019
Author: funilrys <[email protected]>
Date:   Sat Sep 21 21:08:39 2024 +0200

    Merge remote-tracking branch 'origin/dev' into switch-to-mkdocs

commit c9d246e
Author: funilrys <[email protected]>
Date:   Sat Sep 21 21:07:10 2024 +0200

    Cleanup requirements.

commit bb966ee
Author: funilrys <[email protected]>
Date:   Sat Sep 21 20:56:53 2024 +0200

    Add missing files.

commit 776d9a5
Author: funilrys <[email protected]>
Date:   Sat Sep 21 20:54:36 2024 +0200

    introduction of the documentation deployment

commit a4af323
Author: funilrys <[email protected]>
Date:   Sat Sep 21 20:14:20 2024 +0200

    Update documentation URL.

commit f30d6eb
Author: funilrys <[email protected]>
Date:   Sat Sep 21 20:11:58 2024 +0200

    fix typo.

commit 3053e19
Author: funilrys <[email protected]>
Date:   Sat Sep 21 20:09:05 2024 +0200

    Remove old docs.

    Please find the old docs in: https://github.com/PyFunceble/rst-docs

commit 4c20487
Author: funilrys <[email protected]>
Date:   Sun Jun 23 19:09:13 2024 +0200

    Let push internaly

commit 818b173
Author: funilrys <[email protected]>
Date:   Sun Jun 23 16:32:59 2024 +0200

    CI: Reduce workflow for docs generation

commit 697c2f0
Author: funilrys <[email protected]>
Date:   Sun Jun 23 16:30:42 2024 +0200

    CI: Fix typo

commit 169eb61
Author: funilrys <[email protected]>
Date:   Sun Jun 23 16:26:58 2024 +0200

    CI: Add tmp workflow to publish docs images.

commit a172eca
Author: funilrys <[email protected]>
Date:   Sun Jun 23 14:39:00 2024 +0200

    collection -> platform

commit a309e58
Author: funilrys <[email protected]>
Date:   Sun Jun 23 14:22:04 2024 +0200

    Update environment variables documentation

commit b14385d
Author: funilrys <[email protected]>
Date:   Sun Jun 23 14:13:10 2024 +0200

    Update mkdocs.yml.

commit 8852eea
Author: funilrys <[email protected]>
Date:   Sun Jun 23 14:09:07 2024 +0200

    Add index.md.

commit c57e1f9
Author: funilrys <[email protected]>
Date:   Sun Jun 23 12:57:50 2024 +0200

    Dark theme as default.

    Contributors:
      * @spirillen

commit 27625f4
Author: funilrys <[email protected]>
Date:   Sun Jun 23 12:57:19 2024 +0200

    Fix issue when folder has been already deleted.

commit 93340db
Author: funilrys <[email protected]>
Date:   Sun Jun 23 12:50:15 2024 +0200

    Update api-references.

commit cefd371
Author: funilrys <[email protected]>
Date:   Sun Jun 23 12:49:53 2024 +0200

    Ensure that we cleanup api-references folder first.

commit da9fbed
Merge: f3219e3 f848dc9
Author: funilrys <[email protected]>
Date:   Sun Jun 23 12:43:58 2024 +0200

    Merge remote-tracking branch 'origin/dev' into switch-to-mkdocs

commit f3219e3
Merge: 8629879 49b5b82
Author: funilrys <[email protected]>
Date:   Sat Apr 27 19:32:35 2024 +0200

    Merge remote-tracking branch 'origin/dev' into switch-to-mkdocs

commit 8629879
Merge: 72b194f d9cebb1
Author: funilrys <[email protected]>
Date:   Sat Apr 27 19:27:03 2024 +0200

    Merge remote-tracking branch 'origin/dev' into switch-to-mkdocs

commit 72b194f
Merge: baea2ba be1a983
Author: funilrys <[email protected]>
Date:   Tue Apr 9 05:45:44 2024 +0200

    Merge remote-tracking branch 'origin/dev' into switch-to-mkdocs

commit baea2ba
Author: funilrys <[email protected]>
Date:   Wed Dec 20 15:35:21 2023 +0100

    Fix dependencies.

    This patch fixes #340 (comment).

    Contributors:
      * @spirillen

commit 87bd749
Merge: 9ad3239 04826e2
Author: funilrys <[email protected]>
Date:   Tue Dec 19 18:18:23 2023 +0100

    Merge remote-tracking branch 'origin/dev' into switch-to-mkdocs

commit 9ad3239
Merge: 4557872 5bc8b02
Author: funilrys <[email protected]>
Date:   Tue Dec 19 18:09:56 2023 +0100

    Merge remote-tracking branch 'origin/dev' into switch-to-mkdocs

commit 4557872
Author: funilrys <[email protected]>
Date:   Tue Dec 19 17:35:20 2023 +0100

    Fix some typos and semantics.

commit 8a82dd0
Author: funilrys <[email protected]>
Date:   Sun Sep 3 13:07:41 2023 +0200

    Update showcase gif.

commit 73467f5
Author: funilrys <[email protected]>
Date:   Sat Aug 26 00:03:18 2023 +0200

    Add getting started and examples pages.

commit 6abfd06
Merge: 0605e6a 11231f8
Author: funilrys <[email protected]>
Date:   Fri Aug 25 18:11:35 2023 +0200

    Merge remote-tracking branch 'origin/dev' into switch-to-mkdocs

commit 0605e6a
Author: funilrys <[email protected]>
Date:   Sun Aug 20 20:31:49 2023 +0200

    Update documentation.

commit 6789b99
Merge: bd6579a 214a57d
Author: funilrys <[email protected]>
Date:   Sun Aug 20 14:41:54 2023 +0200

    Merge remote-tracking branch 'origin/dev' into switch-to-mkdocs

commit bd6579a
Author: funilrys <[email protected]>
Date:   Wed Jul 26 14:12:44 2023 +0200

    Clarify purpose of docs/gen_ref_pages.py script.

commit 736a86f
Author: funilrys <[email protected]>
Date:   Wed Jul 26 14:11:26 2023 +0200

    Add warning about chancy mode.

commit 1c05886
Author: funilrys <[email protected]>
Date:   Wed Jul 26 10:11:48 2023 +0200

    Add git instruction - when necessary.

commit 1571b66
Author: funilrys <[email protected]>
Date:   Wed Jul 26 10:10:25 2023 +0200

    Add support for sphinx-format.

commit 0c55bad
Author: funilrys <[email protected]>
Date:   Sun Jun 18 10:46:15 2023 +0200

    Add more pages.

commit d51c966
Author: funilrys <[email protected]>
Date:   Sat Jun 17 20:08:34 2023 +0200

    Update state.

commit 8c16f7b
Merge: f3e60a1 fc00231
Author: funilrys <[email protected]>
Date:   Sun May 28 12:56:30 2023 +0200

    Merge remote-tracking branch 'origin/dev' into switch-to-mkdocs

commit f3e60a1
Author: funilrys <[email protected]>
Date:   Sat May 27 13:27:25 2023 +0200

    Update documentation.

commit 1c795c7
Author: funilrys <[email protected]>
Date:   Mon May 22 22:41:23 2023 +0200

    Add more pages into new documentation.

commit 0a4e54c
Author: funilrys <[email protected]>
Date:   Sun May 21 17:41:35 2023 +0200

    Add .all-contributorsrc.

commit 250b541
Author: funilrys <[email protected]>
Date:   Sun May 21 17:19:21 2023 +0200

    Add all-contributors flag.

commit a3286b7
Author: funilrys <[email protected]>
Date:   Sun May 21 17:11:41 2023 +0200

    Update CODE_OF_CONDUCT.md.

commit b1f4565
Author: funilrys <[email protected]>
Date:   Sun May 21 17:11:07 2023 +0200

    Update CONTRIBUTING.md.

commit ba04b02
Author: funilrys <[email protected]>
Date:   Sun May 21 16:41:03 2023 +0200

    Store current state.

commit d70d226
Author: funilrys <[email protected]>
Date:   Sun May 21 15:57:46 2023 +0200

    Fix typo.

commit c9d06db
Author: funilrys <[email protected]>
Date:   Sun May 21 15:54:23 2023 +0200

    Switch format to markdown.

commit ee25566
Author: funilrys <[email protected]>
Date:   Sun May 21 15:53:00 2023 +0200

    Rename CONTRIBUTING.rst to CONTRIBUTING.md.

commit c70742b
Author: funilrys <[email protected]>
Date:   Sun May 21 15:52:36 2023 +0200

    Rename CODE_OF_CONDUCT.rst to CODE_OF_CONDUCT_md.

commit 847326c
Author: funilrys <[email protected]>
Date:   Sun May 21 15:47:11 2023 +0200

    Remove README.rst switch to README.md.
  • Loading branch information
@funilrys
funilrys committed Sep 21, 2024
1 parent 93ec019 commit 8e73f7c
Show file tree
Hide file tree
Showing 213 changed files with 5,861 additions and 13,035 deletions.
22 changes: 22 additions & 0 deletions .all-contributorsrc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"projectName": "pyfunceble",
"projectOwner": "funilrys",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
"README.md",
"CONTRIBUTORS.md",
"docs/about/contributors.md"
],
"imageSize": 100,
"commit": false,
"commitConvention": "gitmoji",
"contributorsPerLine": 7,
"contributorsSortAlphabetically": false,
"badgeTemplate": "[![All Contributors](https://img.shields.io/github/all-contributors/<%= projectOwner %>/<%= projectName %>?color=ee8449&style=flat-square)](#contributors)",
"contributorTemplate": "<a href=\"<%= contributor.profile %>\"><img src=\"<%= contributor.avatar_url %>\" width=\"<%= options.imageSize %>px;\" alt=\"\"/><br /><sub><b><%= contributor.name %></b></sub></a>",
"wrapperTemplate": "\n<table>\n <tbody><%= bodyContent %> </tbody>\n<%= tableFooterContent %></table>\n\n",
"linkToUsage": true,
"skipCi": true,
"contributors": []
}
87 changes: 85 additions & 2 deletions .github/workflows/dev.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ jobs:
PYFUNCEBLE_DB_HOST: "127.0.0.1"
PYFUNCEBLE_DB_NAME: pyfunceble
PYFUNCEBLE_DB_PASSWORD: my_pyfunceble_password
PYFUNCEBLE_DB_PORT: "3306"
PYFUNCEBLE_DB_PORT: "5432"
PYFUNCEBLE_DB_USERNAME: pyfunceble

strategy:
Expand Down Expand Up @@ -338,8 +338,91 @@ jobs:
password: ${{ secrets.PYPI_DEV_API_TOKEN }}
skip-existing: true

deploy_docs_container:
needs: [run_cli, run_cli_mariadb, run_cli_postgresql]
name: "Deploy 🗎 (📦)"

if: github.event_name == 'push' && github.ref == 'refs/heads/dev'

runs-on: "${{ matrix.os }}"

strategy:
fail-fast: false
matrix:
python_version:
- "3.12"
os:
- ubuntu-latest

env:
DOCKER_PYTHON_VERSION: "3.11"
BUILDER_CLONE_DIRNAME: pyfunceble_docker

steps:
- uses: actions/checkout@v4
name: Clone repository

- uses: actions/checkout@v4
name: Clone docker 📦 repository
with:
repository: PyFunceble/docker
path: ${{ env.BUILDER_CLONE_DIRNAME }}/

- name: Set up Python ${{ matrix.python_version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python_version }}

- name: Install dependencies
run: |
pip install --upgrade pip
pip install setuptools wheel
pip install ${{ env.BUILDER_CLONE_DIRNAME }}/.
- name: Get version of builder
run: |
pyfunceble-docker-builder --version
- name: Read package name
run: |
python setup.py --name
- name: Read package version
run: |
python setup.py --version
- name: Read commit ID
run: |
git log -1 --format=format:'%H'
- name: Build, Check and Publish 📦 to Docker Hub
run: >
set -x ;
pyfunceble-docker-builder -b ${{ env.BUILDER_CLONE_DIRNAME }}/docs_builder
-p docs
--pyfunceble-version="$(python setup.py --version)"
--python-version="${DOCKER_PYTHON_VERSION}"
--is-latest --publish --commit="$(git log -1 --format=format:'%H')"
env:
OUR_DOCKER_USERNAME: ${{ secrets.OUR_DOCKER_USERNAME }}
OUR_DOCKER_PASSWORD: ${{ secrets.OUR_DOCKER_PASSWORD }}
OUR_DOCKER_EMAIL: ${{ secrets.OUR_DOCKER_EMAIL }}

- name: Build, Check and Publish 📦 to Internal Hub
run: >
set -x ;
pyfunceble-docker-builder -b ${{ env.BUILDER_CLONE_DIRNAME }}/docs_builder
-p docs
--pyfunceble-version="$(python setup.py --version)"
--python-version="${DOCKER_PYTHON_VERSION}"
--is-latest --publish --commit="$(git log -1 --format=format:'%H')"
env:
OUR_DOCKER_USERNAME: ${{ secrets.INTERNAL_DOCKER_USERNAME }}
OUR_DOCKER_PASSWORD: ${{ secrets.INTERNAL_DOCKER_PASSWORD }}
OUR_DOCKER_REGISTRY: ${{ secrets.INTERNAL_DOCKER_REGISTRY }}

deploy_to_docker_hub:
needs: [run_cli, run_cli_mariadb]
needs: [run_cli, run_cli_mariadb, run_cli_postgresql]
name: "Deploy 📦 to the Docker Hub"

if: github.event_name == 'push' && github.ref == 'refs/heads/dev'
Expand Down
193 changes: 193 additions & 0 deletions .github/workflows/switch-to-mkdocs.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,193 @@
name: Switch-To-Mkdocs Development Workflow
on:
push:
branches:
- switch-to-mkdocs
schedule:
- cron: "0 0 * * *"

jobs:
lint:
name: Lint PyFunceble

runs-on: "${{ matrix.os }}"

strategy:
fail-fast: false
matrix:
python_version:
- "3.12"
os:
- ubuntu-latest

steps:
- uses: actions/checkout@v4
name: Clone repository

- name: Set up Python ${{ matrix.python_version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python_version }}

- name: Install dependencies
run: |
pip install --upgrade pip
pip install -r requirements.txt
pip install pylint
- name: Lint PyFunceble with Pylint
run: pylint PyFunceble

- name: Lint tests with Pylint
run: pylint tests

test:
needs: [lint]
name: "[${{ matrix.os }}-py${{ matrix.python_version }}] Test PyFunceble"

runs-on: "${{ matrix.os }}"

strategy:
fail-fast: false
matrix:
python_version:
- "3.8"
- "3.9"
- "3.10"
- "3.11"
- "3.12"
os:
- ubuntu-latest
- macos-latest
- windows-latest

steps:
- uses: actions/checkout@v4
name: Clone repository

- name: Set up Python ${{ matrix.python_version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python_version }}

- name: Install dependencies
run: |
pip install --upgrade pip
pip install -r requirements.txt
pip install tox coveralls
- name: Test PyFunceble as defined by tox.ini
run: |
tox -c tox.ini
- name: Upload Coverage
continue-on-error: true
run: |
coveralls
env:
COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
COVERALLS_PARALLEL: true

coveralls:
needs: test
name: Finish Coveralls

runs-on: "${{ matrix.os }}"

strategy:
fail-fast: false
matrix:
python_version:
- "3.12"
os:
- ubuntu-latest

steps:
- name: Sending finish flag to coveralls.io
uses: coverallsapp/github-action@v2
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
parallel-finished: true

deploy_to_docker_hub:
needs: [test]
name: "Deploy Documentation 📦 to the Docker Hub"

if: github.event_name == 'push' && github.ref == 'refs/heads/switch-to-mkdocs'

runs-on: "${{ matrix.os }}"

strategy:
fail-fast: false
matrix:
python_version:
- "3.12"
os:
- ubuntu-latest

env:
DOCKER_PYTHON_VERSION: "3.11"
BUILDER_CLONE_DIRNAME: pyfunceble_docker

steps:
- uses: actions/checkout@v4
name: Clone repository

- uses: actions/checkout@v4
name: Clone docker 📦 repository
with:
repository: PyFunceble/docker
path: ${{ env.BUILDER_CLONE_DIRNAME }}/

- name: Set up Python ${{ matrix.python_version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python_version }}

- name: Install dependencies
run: |
pip install --upgrade pip
pip install setuptools wheel
pip install ${{ env.BUILDER_CLONE_DIRNAME }}/.
- name: Get version of builder
run: |
pyfunceble-docker-builder --version
- name: Read package name
run: |
python setup.py --name
- name: Read package version
run: |
python setup.py --version
- name: Read commit ID
run: |
git log -1 --format=format:'%H'
- name: Build, Check and Publish 📦 to Docker Hub
run: >
set -x ;
pyfunceble-docker-builder -b ${{ env.BUILDER_CLONE_DIRNAME }}/docs_builder
-p docs
--pyfunceble-version="$(python setup.py --version)"
--python-version="${DOCKER_PYTHON_VERSION}"
--is-latest --publish --commit="$(git log -1 --format=format:'%H')"
env:
OUR_DOCKER_USERNAME: ${{ secrets.OUR_DOCKER_USERNAME }}
OUR_DOCKER_PASSWORD: ${{ secrets.OUR_DOCKER_PASSWORD }}
OUR_DOCKER_EMAIL: ${{ secrets.OUR_DOCKER_EMAIL }}

- name: Build, Check and Publish 📦 to Internal Hub
run: >
set -x ;
pyfunceble-docker-builder -b ${{ env.BUILDER_CLONE_DIRNAME }}/docs_builder
-p docs
--pyfunceble-version="$(python setup.py --version)"
--python-version="${DOCKER_PYTHON_VERSION}"
--is-latest --publish --commit="$(git log -1 --format=format:'%H')"
env:
OUR_DOCKER_USERNAME: ${{ secrets.INTERNAL_DOCKER_USERNAME }}
OUR_DOCKER_PASSWORD: ${{ secrets.INTERNAL_DOCKER_PASSWORD }}
OUR_DOCKER_REGISTRY: ${{ secrets.INTERNAL_DOCKER_REGISTRY }}
Loading

0 comments on commit 8e73f7c

Please sign in to comment.