📝 Migrate doc to pdoc and docstring with full markdown style (#74)

* 📝 Migrate doc to pdoc * 🙈 Ignore doc/build * 👷 Add pdoc workflow * 📝 Write cross-references compatible with pdoc * 🔥 Remove unused readthedocs config file * 🚚 Move documentation on a dedicated file at root * 🔧 The pypi readme is now the same as github * 📝 Migrate doc links to pdoc * 🚚 Use new DOCUMENTATION.md file in description * 📝 Move license nnotice in __init__.py * 🐛 Change module path in pdoc command * 🐛 Change module path in pdoc command * 🐛 Change module path in pdoc command * 🐛 Change module path in pdoc command * 🐛 Change module path in pdoc command * 🐛 Change module path in pdoc command * 🐛 Change module path in pdoc command * 📝 Remove header * 📝 Modify header * 🐛 Change module path in pdoc command * 🔧 Build doc on pdoc_dev branch * ✏️ Fix doc link * 📝 Change description * 📝 Change path of DOCUMENTATION * 📝 Change path of DOCUMENTA2TION * 📝 Remove documentation in description * 🐛 Change to google format * 📝 Code blocs to markdown format * 🔧 Back to numpy format * 🔧 Allow search * 🔧 Use google format for debugging * 🎨 Fix logo link * 📝Add DOCUMENTATION.md on top of documentation * 🎨 Change color theme * 🔧 Prevent behavior changing when __all__ exists * 🎨 Set extended logo * 📝 Better one-line summary of module * 🎨 Change them colors * 💄 Add submodules in __all__ * 🎨 Change color theme * 💄 Add submodules in __all__ * 💥 : Processing is no longer accessible via cliconfig.processing.Processing (use base.Processing instead) * 🎨 Change color theme * 🔧 Allow public module even if not in __all__ * 🔧 Allow functions and attr * 🔧 No include undocumented * 🎨 Fix hover color * 📝 Update processing documentation * 📝 Add end_build_processing to processing paragraph * 🔧 Set format to numpy * 📝 Remove indentation on notes * 📝 De-indent warning sections of docstrings * 🎨 White background * 📝 Add pdoc template * 📝 Minor changes on docstrings * 📝 Minor changes on doc * 🎨 Try another style * 🎨 Change to purple theme * 🎨 White table of content font * 🎨 Change font color * 🎨 Change header font sizes * 🎨 Reduce font size * 🎨 Back to 500 font-height * 🎨 Test new font * 🍱 Change logo with grey versions * 📝 Set black logo * 🔥 Remove binary logo file * 📝 Change to black extend logo * 📝 Add doc and pypi small section * 🔧 Automatic build doc on push in main branch
valentingol · Jan 5, 2024 · e78e803 · e78e803
1 parent 1802652
commit e78e803
Show file tree

Hide file tree

Showing 59 changed files with 2,932 additions and 1,837 deletions.
diff --git a/.github/workflows/pdoc.yaml b/.github/workflows/pdoc.yaml
@@ -0,0 +1,49 @@
+name: Documentation
+
+# build the documentation whenever there are new commits on main
+on:
+  push:
+    branches:
+      - main
+      - pdoc
+      - pdoc_dev
+    # Alternative: only build for tags.
+    # tags:
+    #   - '*'
+
+# security: restrict permissions for CI jobs.
+permissions:
+  contents: read
+
+jobs:
+  # Build the documentation and upload the static HTML files as an artifact.
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - run: pip install -e .
+      - run: pip install -r docs/requirements.txt
+      - run: pdoc -d numpy -t docs/template --logo https://raw.githubusercontent.com/valentingol/cliconfig/main/docs/_static/logo.png --no-include-undocumented -o docs/build --math --search cliconfig
+
+      - uses: actions/upload-pages-artifact@v1
+        with:
+          path: docs/build
+
+  # Deploy the artifact to GitHub pages.
+  # This is a separate job so that only actions/deploy-pages has the necessary permissions.
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v1
diff --git a/.gitignore b/.gitignore
@@ -23,4 +23,5 @@ run.py
 cliconfig/_version.py
 # Docs
 docs/_build
+docs/build
 build
diff --git a/.readthedocs.yaml b/.readthedocs.yaml