Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix readthedocs #54

Merged
merged 5 commits into from
Mar 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/workflows/pypi_test_publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# This workflow will upload a Python Package using Twine when a release is created
name: Upload Python Package to Test PyPi

on: workflow_dispatch

jobs:
deploy_to_test_pypi:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools wheel twine build
- name: Build and publish
env:
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
TWINE_PASSWORD: ${{ secrets.TEST_PYPI_PASSWORD }}
run: |
python -m build -s -w
twine upload dist/*
11 changes: 10 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@
# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.8"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py
Expand All @@ -20,7 +30,6 @@ formats:

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.8
install:
- method: pip
path: .
Expand Down
6 changes: 6 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@
sys.path.insert(0, os.path.abspath('../../spooq'))
# sys.path[0:0] = [os.path.abspath('_themes/foundation-sphinx-theme')]

# Fixes broken plantUML
# https://github.com/mgaitan/sphinxcontrib-mermaid/issues/72
import errno
import sphinx.util.osutil
sphinx.util.osutil.ENOENT = errno.ENOENT

# import easydev
# from recommonmark.parser import CommonMarkParser
# from recommonmark.transform import AutoStructify
Expand Down
1 change: 1 addition & 0 deletions docs/source/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ pyspark==3.3.0
pandas==.1.4.3
sphinxcontrib-plantuml==0.18
docutils<0.18
sphinx_rtd_theme
Cython