Skip to content

Commit b6ea3e2

Browse files
author
Tom Softreck
committed
update structure
1 parent 99dcf8e commit b6ea3e2

File tree

3 files changed

+98
-0
lines changed

3 files changed

+98
-0
lines changed

.readthedocs.yml

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the OS, Python version and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.12"
13+
14+
# Build documentation in the "docs" directory with Sphinx
15+
sphinx:
16+
configuration: docs/conf.py
17+
fail_on_warning: true
18+
19+
# Optionally build your docs in additional formats such as PDF and ePub
20+
formats:
21+
- pdf
22+
- epub
23+
24+
# Optionally set the version of Python and requirements required to build your docs
25+
python:
26+
install:
27+
- requirements: docs/requirements.txt
28+
- method: pip
29+
path: .
30+
extra_requirements:
31+
- docs
32+
33+
# Optionally build documentation from subdirectory
34+
doc_path: docs
35+
36+
# Optionally include or exclude patterns
37+
# exclude_patterns: []
38+
39+
40+
# Optionally include additional paths
41+
git:
42+
submodules: include
43+
submodules_recursive: true
44+
depth: 50
45+
46+
# Optionally set the default branch
47+
default_branch: main
48+
49+
# Optionally set the language of your project
50+
language: en
51+
52+
# Optionally set the conda environment to use
53+
# conda:
54+
# environment: environment.yml
55+
56+
# Optionally specify the requirements file
57+
# requirements_file: requirements.txt
58+
59+
# Optionally include additional build steps
60+
# build:
61+
# image: latest
62+
63+
# Optionally specify the mkdocs configuration
64+
# mkdocs:
65+
# configuration: mkdocs.yml
66+
# fail_on_warning: true

docs/index.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# TaskProvision Documentation
2+
3+
Welcome to the official documentation for TaskProvision, an AI-Powered Development Automation Platform.
4+
5+
## Getting Started
6+
7+
- [Installation](installation.md)
8+
- [Quickstart](quickstart.md)
9+
- [Configuration](configuration.md)
10+
11+
## User Guide
12+
13+
- [Core Concepts](guide/concepts.md)
14+
- [API Reference](api/index.md)
15+
- [Examples](examples/index.md)
16+
17+
## Development
18+
19+
- [Contributing](development/contributing.md)
20+
- [Code of Conduct](development/code_of_conduct.md)
21+
- [Changelog](https://github.com/taskprovision/taskprovision/blob/main/CHANGELOG.md)
22+
23+
## Support
24+
25+
- [FAQ](faq.md)
26+
- [Troubleshooting](troubleshooting.md)
27+
- [Report an Issue](https://github.com/taskprovision/python/issues)

docs/requirements.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
sphinx>=7.0.0
2+
sphinx-rtd-theme>=1.0.0
3+
myst-parser>=1.0.0
4+
sphinx-copybutton>=0.5.0
5+
sphinxcontrib-mermaid>=0.7.1

0 commit comments

Comments
 (0)