Skip to content

Commit 5294366

Browse files
[major] update documentation deployment
1 parent 8254fd1 commit 5294366

File tree

3 files changed

+42
-2
lines changed

3 files changed

+42
-2
lines changed

docs/requirements.txt

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
furo @ git+https://github.com/frogcjn/torchquantum-doc-furo-theme.git
2+
nbsphinx
3+
recommonmark
4+
5+
torchquantum>=0.1
6+
opt_einsum

docs/source/conf.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@
2929
import sys
3030
import os
3131
sys.path.insert(0, os.path.abspath('../..'))
32-
import furo
3332

3433
#import pathlib
3534
#sys.path.insert(0, pathlib.Path(__file__).parents[2].resolve().as_posix())
@@ -160,4 +159,4 @@
160159
display_gitlab = False
161160
show_source = True
162161
# -- Options for EPUB output
163-
epub_show_urls = 'footnote'
162+
epub_show_urls = 'footnote'

readthedocs.yaml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Read the Docs configuration file for Sphinx projects
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version and other tools you might need
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.10"
12+
# You can also specify other tool versions:
13+
# nodejs: "20"
14+
# rust: "1.70"
15+
# golang: "1.20"
16+
17+
# Build documentation in the "docs/" directory with Sphinx
18+
sphinx:
19+
configuration: docs/source/conf.py
20+
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
21+
# builder: "dirhtml"
22+
# Fail on all warnings to avoid broken references
23+
# fail_on_warning: true
24+
25+
# Optionally build your docs in additional formats such as PDF and ePub
26+
# formats:
27+
# - pdf
28+
# - epub
29+
30+
# Optional but recommended, declare the Python requirements required
31+
# to build your documentation
32+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
33+
python:
34+
install:
35+
- requirements: docs/requirements.txt

0 commit comments

Comments
 (0)