Skip to content

Commit

Permalink
chore: deploy read-the-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xeroc committed Jul 1, 2024
1 parent 976d199 commit 490ea6d
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 4 deletions.
10 changes: 10 additions & 0 deletions .github/workflows/main.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Test, build and deploy for Test

on:
push:
branches:
- main

jobs:
test:
uses: ./.github/workflows/test.yaml
31 changes: 31 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# .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 OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"
jobs:
post_create_environment:
# Install poetry
# https://python-poetry.org/docs/#installing-manually
- pip install poetry
post_install:
# Install dependencies with 'docs' dependency group
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
# VIRTUAL_ENV needs to be set manually for now.
# See https://github.com/readthedocs/readthedocs.org/pull/11152/
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs

# Build documentation with mkdocs
mkdocs:
configuration: mkdocs.yml
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
[![CircleCI](https://circleci.com/gh/google/pybadges.svg?style=svg)](https://circleci.com/gh/google/pybadges)
[![.github/workflows/release.yaml](https://github.com/xeroc/python-solana-actions/actions/workflows/release.yaml/badge.svg?branch=main)](https://github.com/xeroc/python-solana-actions/actions/workflows/release.yaml)
![pypi](https://img.shields.io/pypi/v/solana-actions.svg)
![versions](https://img.shields.io/pypi/pyversions/solana-actions.svg)
[![documentation](https://readthedocs.org/projects/python-solana-actions/badge/?version=latest&style=for-the-badge)](https://python-solana-actions.readthedocs.org)
[![documentation](https://readthedocs.org/projects/python-solana-actions/badge/?version=latest)](https://python-solana-actions.readthedocs.org)

# python-solana-actions

Solana Actions library in python.

## Documentation

Full Documentation is available on [python-solana-actions.rtfd.io](https://python-solana-actions.rtfd.io).

## Installation

pip3 install solana-actions
Expand Down
2 changes: 1 addition & 1 deletion poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 6 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,14 @@ coverage = "^7.5.4"
black = "^24.4.2"
mypy = "^1.10.1"
autoflake = "^2.3.1"
mkdocs-material = "^9.5.27"
pytest-asyncio = "^0.23.7"

[tool.poetry.group.docs]
optional = true

[tool.poetry.group.docs.dependencies]
mkdocs-material = "^9.5.27"

[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"
Expand Down

0 comments on commit 490ea6d

Please sign in to comment.