Skip to content

Commit 8a9a672

Browse files
committed
docs refactor: rename doc to docs, and adopt a docs/source folder
1 parent 0734b58 commit 8a9a672

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+17
-17
lines changed

.github/workflows/publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ on:
55
paths-ignore:
66
- "**.md"
77
- "**.rst"
8-
- "doc/**"
8+
- "docs/**"
99
- "examples/**"
1010
- ".github/workflows/**"
1111
- "!.github/workflows/publish.yml"
1212
push:
1313
paths-ignore:
1414
- "**.md"
1515
- "**.rst"
16-
- "doc/**"
16+
- "docs/**"
1717
- "examples/**"
1818
- ".github/workflows/**"
1919
- "!.github/workflows/publish.yml"

.github/workflows/test.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ on:
88
paths-ignore:
99
- "**.md"
1010
- "**.rst"
11-
- "doc/**"
11+
- "docs/**"
1212
- "examples/**"
1313
- ".github/workflows/**"
1414
- "!.github/workflows/test.yml"
1515
push:
1616
paths-ignore:
1717
- "**.md"
1818
- "**.rst"
19-
- "doc/**"
19+
- "docs/**"
2020
- "examples/**"
2121
- ".github/workflows/**"
2222
- "!.github/workflows/test.yml"

.readthedocs.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
version: 2
66

77
sphinx:
8-
configuration: doc/conf.py
8+
configuration: docs/source/conf.py
99

1010
build:
1111
os: ubuntu-22.04
@@ -14,4 +14,4 @@ build:
1414

1515
python:
1616
install:
17-
- requirements: doc/requirements.txt
17+
- requirements: docs/requirements.txt

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions

doc/contribute.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

doc/Makefile renamed to docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# from the environment for the first two.
66
SPHINXOPTS ?=
77
SPHINXBUILD ?= sphinx-build
8-
SOURCEDIR = .
8+
SOURCEDIR = source
99
BUILDDIR = _build
1010

1111
# Put it first so that "make" without argument is like "make help".

doc/make.bat renamed to docs/make.bat

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ REM Command file for Sphinx documentation
77
if "%SPHINXBUILD%" == "" (
88
set SPHINXBUILD=sphinx-build
99
)
10-
set SOURCEDIR=.
10+
set SOURCEDIR=source
1111
set BUILDDIR=_build
1212

1313
if "%1" == "" goto help
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)