diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 0000000..90eb291 --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,46 @@ +name: Publish documentation +on: + push: + branches: + - main + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + mkdocs: + + runs-on: ubuntu-latest + timeout-minutes: 20 + environment: github-pages + + permissions: + pages: write + id-token: write + + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: '3.11' + + - name: Install and configure Poetry + uses: snok/install-poetry@v1 + + - name: Install dependencies + run: poetry install + + - name: Build the docs site + run: poetry run mkdocs build + + - name: Upload site artifactory + uses: actions/upload-pages-artifact@v3 + with: + path: site + + - name: Deploy to GitHub Pages + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml index a5494d2..19d7899 100644 --- a/.github/workflows/tests.yaml +++ b/.github/workflows/tests.yaml @@ -10,7 +10,6 @@ concurrency: cancel-in-progress: true jobs: - python: strategy: diff --git a/.gitignore b/.gitignore index 0872fe6..f7679f3 100644 --- a/.gitignore +++ b/.gitignore @@ -130,6 +130,9 @@ ENV/ env.bak/ venv.bak/ +# Mkdocs build +site/ + # Spyder project settings .spyderproject .spyproject diff --git a/docs/index.md b/docs/index.md index 50fa1ff..d92b46b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,6 +7,11 @@ A simple to use abstraction over Selenium. +- [x] **Easy to use**: complex interactions are abstracted to intuitive methods. +- [x] **Clean imports**: remove the necessity of import many packages and objects. Every automation features are accessible by methods of one main object. +- [x] **Typed**: type hints grant the code readability, and turn possible to navigate through the methods with any Intellisense tool. +- [x] **Selenium safe**: the core are developed following the Selenium best-practices. + ## Installation To perform a basic installation, just run: diff --git a/mkdocs.yml b/mkdocs.yml index 067727f..76bea43 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,6 +4,21 @@ repo_url: https://github.com/jjpaulo2/fastrpa theme: name: material + icon: + logo: fontawesome/solid/window-restore + palette: + - scheme: default + primary: green + accent: teal + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - scheme: slate + primary: green + accent: teal + toggle: + icon: material/brightness-4 + name: Switch to light mode features: - search.suggest - content.code.copy @@ -41,3 +56,5 @@ markdown_extensions: anchor_linenums: true line_spans: __span pygments_lang_class: true + - pymdownx.tasklist: + custom_checkbox: true