Skip to content
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
11 changes: 3 additions & 8 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -117,23 +117,18 @@ jobs:
timeout-minutes: 15
needs: lint
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
env-list: [doc-build, doc-build-multi]
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
# need to pin to 3.10 cause sphinx-multiversion latest code have but gather equal than 3.11
python-version: '3.10'
python-version: 3.13
- name: Install Dependences
run: |
python -m pip install --upgrade ${{ env.DEPENDENCES }}
- name: Run Build Docs Tests ${{ matrix.env-list }}
- name: Run Build Docs Tests
run: |
python -m tox -vv -e ${{ matrix.env-list }}
python -m tox -vv -e doc-build
local-ci:
timeout-minutes: 15
needs:
Expand Down
17 changes: 2 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ define by code, user usually do not care user, tenant, or queue exists or not. A
a new workflow according the code definition. So we have some **models object** in `pydolphinscheduler/models`
directory, their only check object exists or not, and create them if not exists.

More detail about core concept, please read [concept](https://dolphinscheduler.apache.org/python/main/concept.html)
More detail about core concept, please read [concept](https://dolphinscheduler.apache.org/python/concept.html)
in our documentation.

## Syntax To Trigger Specific CI During Pull Request
Expand Down Expand Up @@ -177,14 +177,10 @@ GitHub. You may locally ensure docs could be built successfully in case the fail

### Build Document Automatically with tox

We integrated document build process into tox, you can build the latest document and all document(including history documents) via
single command
We integrated document build process into tox, and you can build the latest documentation via a single command.

```shell
# Build the latest document in dev branch
tox -e doc-build
# Build all documents, which including the latest and all history documents
tox -e doc-build-multi
```

### Build Document Manually
Expand All @@ -202,15 +198,6 @@ cd pydolphinscheduler/docs/
make clean && make html
```

or if you want to build history documents, you should execute the command below

```shell
# Fetch all history tags because we use tag to build history documents via [sphinx-multiversion](https://holzhaus.github.io/sphinx-multiversion/master/index.html)
git fetch --tags
cd pydolphinscheduler/docs/
make clean && make multiversion
```

## Unit Test

pydolphinscheduler using [pytest][pytest] to test our codebase. GitHub Action will run our test when you create
Expand Down
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ under the License.
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat-square&labelColor=ef8336)](https://pycqa.github.io/isort)
[![CI](https://github.com/apache/dolphinscheduler-sdk-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/apache/dolphinscheduler-sdk-python/actions/workflows/ci.yaml)
[![Twitter Follow](https://img.shields.io/twitter/follow/dolphinschedule.svg?style=social&label=Follow)](https://twitter.com/dolphinschedule)
[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://s.apache.org/dolphinscheduler-slack)

**PyDolphinScheduler** is python API for [Apache DolphinScheduler](https://dolphinscheduler.apache.org),
which allow you definition your workflow by python code, aka workflow-as-codes.
Expand All @@ -39,7 +38,7 @@ which allow you definition your workflow by python code, aka workflow-as-codes.
### Version Compatibility

At Nov 7, 2022 we seperated PyDolphinScheduler from DolphinScheduler, and the version of PyDolphinScheduler 4.0.0
can match multiple versions of DolphinScheduler, for more details, please refer to [version](https://dolphinscheduler.apache.org/python/main/index.html#version)
can match multiple versions of DolphinScheduler, for more details, please refer to [version](https://dolphinscheduler.apache.org/python/index.html#version)

### Installation

Expand Down Expand Up @@ -96,7 +95,7 @@ Project Management, please refer to [DolphinScheduler Workflow](https://dolphins

## Documentation

For full documentation visit [document](https://dolphinscheduler.apache.org/python/main/index.html). This
For full documentation visit [document](https://dolphinscheduler.apache.org/python/index.html). This
documentation is generated from this repository so please raise issues or pull requests for any additions, corrections, or clarifications.

## Contributing
Expand Down
2 changes: 0 additions & 2 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ but we also have a [PyPi](#release-to-pypi) repository for Python package distri
add check whether apache/dolphinscheduler commit is released, for some commit not release should revert the change
* Run all test locally, `tox -e local-ci && tox -e local-integrate-test`, after you start dolphinscheduler to
pass `local-integrate-test`
* Remove `sphinx-multiversion` dependency in `setup.cfg`, we still can not fix this issue
[Distribute tarball and wheel error with direct dependency](https://github.com/apache/dolphinscheduler/issues/12238)

## Build and Sign Package

Expand Down
5 changes: 0 additions & 5 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
# Add opts `turn warnings into errors` strict sphinx-build behavior
SPHINXOPTS ?= -W
SPHINXBUILD ?= sphinx-build
SPHINXMULTIVERSION ?= sphinx-multiversion
SOURCEDIR = source
BUILDDIR = build

Expand All @@ -38,7 +37,3 @@ help:
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

# Create multiple version of docs
multiversion:
@$(SPHINXMULTIVERSION) "$(SOURCEDIR)" "$(BUILDDIR)/html"
7 changes: 0 additions & 7 deletions docs/source/changelog.rst

This file was deleted.

24 changes: 1 addition & 23 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,10 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
import os
import sys
from pathlib import Path

# For sphinx-multiversion, we need to build API docs of the corresponding package version, related issue:
# https://github.com/Holzhaus/sphinx-multiversion/issues/42
pkg_src_dir = (
Path(os.environ.get("SPHINX_MULTIVERSION_SOURCEDIR", default="."))
.joinpath("../../src")
.resolve()
)
pkg_src_dir = Path(__file__).resolve().parents[2].joinpath("src")
sys.path.insert(0, str(pkg_src_dir))

from pydolphinscheduler import __version__ # noqa
Expand Down Expand Up @@ -76,26 +69,11 @@
# Add inline tabbed content
"sphinx_inline_tabs",
"sphinx_copybutton",
"sphinx_multiversion",
"sphinx_github_changelog",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

# sphinx_multiversion configuration
html_sidebars = {
"**": [
"versioning.html",
],
}
# Match all exists tag for pydolphinscheduler expect version 2.0.4(not release apache dolphinscheduler)
smv_tag_whitelist = r"^(?!2.0.4)\d+\.\d+\.\d+$"
smv_branch_whitelist = "main"
smv_remote_whitelist = r"^(origin|upstream)$"
smv_released_pattern = "^refs/tags/.*$"
smv_outputdir_format = "versions/{ref.name}"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
Expand Down
1 change: 0 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,6 @@ then go and see :doc:`tutorial` for more detail.
config
api
resources_plugin/index
changelog

Indices and tables
==================
Expand Down
24 changes: 3 additions & 21 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
[metadata]
name = apache-dolphinscheduler
version = attr: pydolphinscheduler.__version__
url = https://dolphinscheduler.apache.org/python/main/index.html
url = https://dolphinscheduler.apache.org/python/index.html
description = pydolphinscheduler is Apache DolphinScheduler Python API.
long_description = file: README.md
long_description_content_type = text/markdown
Expand Down Expand Up @@ -51,8 +51,8 @@ classifiers =
Programming Language :: Python :: Implementation :: PyPy
Topic :: Software Development :: User Interfaces
project_urls =
Homepage = https://dolphinscheduler.apache.org/python/main/index.html
Documentation = https://dolphinscheduler.apache.org/python/main/index.html
Homepage = https://dolphinscheduler.apache.org/python/index.html
Documentation = https://dolphinscheduler.apache.org/python/index.html
Source = https://github.com/apache/dolphinscheduler-sdk-python
Issue Tracker = https://github.com/apache/dolphinscheduler-sdk-python/issues
Twitter = https://twitter.com/dolphinschedule
Expand Down Expand Up @@ -109,11 +109,6 @@ doc =
sphinx-click>=3.0
sphinx-inline-tabs
sphinx-copybutton>=0.4.0
# Unreleased package have a feature we want(use correct version package for API ref), so we install from
# GitHub directly, see also:
# https://github.com/Holzhaus/sphinx-multiversion/issues/42#issuecomment-1210539786
sphinx-multiversion @ git+https://github.com/Holzhaus/sphinx-multiversion#egg=sphinx-multiversion
sphinx-github-changelog
dev =
# build
apache-dolphinscheduler[build]
Expand Down Expand Up @@ -165,7 +160,6 @@ envlist =
auto-lint
lint
doc-build
doc-build-multi
code-test
integrate-test
local-integrate-test
Expand Down Expand Up @@ -204,17 +198,6 @@ commands =
commands_post =
find {toxinidir}/docs -type f -name "environment.pickle" -exec rm -rf \{\} \;

[testenv:doc-build-multi]
extras = doc
commands =
# Get all tags for `multiversion` subcommand
git fetch --tags
make -C {toxinidir}/docs clean
make -C {toxinidir}/docs multiversion
# Remove sensitive information from the generated documentation
commands_post =
find {toxinidir}/docs -type f -name "environment.pickle" -exec rm -rf \{\} \;

[testenv:integrate-test]
extras = test
commands =
Expand All @@ -227,7 +210,6 @@ setenv =
commands =
{[testenv:integrate-test]commands}

# local-ci do not build `doc-build-multi`
[testenv:local-ci]
extras = dev
commands =
Expand Down
Loading
Loading