Skip to content

Commit 1db9c41

Browse files
docs: add requirements for documentation
1️⃣ fix docs failing due to custom extension
1 parent baa522e commit 1db9c41

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

.readthedocs.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# .readthedocs.yaml
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 version of Python and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.9"
13+
14+
# Build documentation in the docs/ directory with Sphinx
15+
sphinx:
16+
configuration: docs/conf.py
17+
18+
# If using Sphinx, optionally build your docs in additional formats such as PDF
19+
formats:
20+
- pdf
21+
- epub
22+
23+
# Optionally declare the Python requirements required to build your docs
24+
python:
25+
install:
26+
- method: pip
27+
path: .
28+
extra_requirements:
29+
- docs
30+
31+
- method: pip
32+
path: .

pyproject.toml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,24 @@ dependencies = [
8686
'six>=1.16.0',
8787
]
8888

89+
90+
[project.optional-dependencies]
91+
92+
docs = [
93+
'Sphinx>=5.0.2',
94+
'sphinx-rtd-theme>=1.0.0',
95+
'sphinx_design>=0.2.0',
96+
]
97+
98+
8999
[project.urls]
90100

91101
# Here is the URL where you can find the code, in this case on GitHub.
92102
Source = 'https://github.com/AsifArmanRahman/firebase-rest-api'
93103

104+
# Here is the URL where you can find the documentation of the library, in this case on Read the Docs.
105+
Documentation = 'https://firebase-rest-api.readthedocs.io/'
106+
107+
94108
[tool.flit.module]
95109
name = 'firebase'

0 commit comments

Comments
 (0)