Skip to content

Commit

Permalink
Added readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertoRoos committed Apr 23, 2024
1 parent e9230ac commit abe7efa
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 1 deletion.
32 changes: 32 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# .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"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py

# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# TwinCAT Tools

[![Documentation Status](https://readthedocs.org/projects/tctools/badge/?version=latest)](https://tctools.readthedocs.io/en/latest/?badge=latest)
[![PyTest](https:/RobertoRoos/tctools/actions/workflows/tests.yml/badge.svg)](https:/RobertoRoos/TcTools/actions)
[![codecov](https://codecov.io/gh/RobertoRoos/TcTools/graph/badge.svg?token=3NU2UNM2U0)](https://codecov.io/gh/RobertoRoos/TcTools)

Expand All @@ -12,7 +13,19 @@ Get it with the usual:
pip install .
```

To develop, use: `pip install -e .[test,doc]`
## Develop

### Requirements

Install the development requirements with:
```
pip install -e .[test,doc]
```

### Documentation

Documentation is built using Sphinx.
This is done automatically and hosted by ReadTheDocs: https://tctools.readthedocs.io/en/latest/

## Tools

Expand Down

0 comments on commit abe7efa

Please sign in to comment.