mirror of
https://github.com/iluvcapra/ptulsconv.git
synced 2026-02-14 22:55:37 +00:00
1fd86a6d7d
* Migrating to uv build and manager * Updated Flake8 settings * Updating github workflow * Update python-package.yml Removed redundant flake8 run * Twiddle * Version number in banner * Changing to ruff linter * Tweaking workflow * Update python-package.yml * Update __init__.py * Update __init__.py * removing flake8 file * Doc notes * Twiddling with RtD --------- Co-authored-by: Jamie Hardt <jamie@squad51.us>
41 lines
1.0 KiB
YAML
41 lines
1.0 KiB
YAML
# .readthedocs.yaml
|
|
# Read the Docs configuration file
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
|
|
# Required
|
|
version: 2
|
|
|
|
# Set the version of Python and other tools you might need
|
|
build:
|
|
os: ubuntu-20.04
|
|
tools:
|
|
python: "3.10"
|
|
jobs:
|
|
pre_install:
|
|
- pip install --upgrade --upgrade-strategy only-if-needed --group doc .
|
|
build:
|
|
html:
|
|
python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
|
|
post_build:
|
|
- echo "Command run at 'post_build' step"
|
|
- echo `date`
|
|
|
|
# Build documentation in the docs/ directory with Sphinx
|
|
sphinx:
|
|
configuration: docs/source/conf.py
|
|
|
|
#If using Sphinx, optionally build your docs in additional formats such as PDF
|
|
formats:
|
|
- pdf
|
|
|
|
# FIXME: We should be installing the `doc` dependency group and not the `doc`
|
|
# extra.
|
|
|
|
#Optionally declare the Python requirements required to build your docs
|
|
# python:
|
|
# install:
|
|
# - method: pip
|
|
# path: .
|
|
# extra_requirements:
|
|
# - doc
|