Skip to content

Commit 56b7ebf

Browse files
doc: use readthedocs files structure
Make structure similar to readthedocs tutorial [1]. 1. https://docs.readthedocs.io/en/stable/tutorial/ Part of #238
1 parent ce80a35 commit 56b7ebf

35 files changed

+2
-2
lines changed

Diff for: Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: install test
1+
.PHONY: install test docs
22
install:
33
pip install --editable .
44
test:

Diff for: README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ To build documentation, first you must install its build requirements:
112112

113113
.. code-block:: bash
114114
115-
$ pip install -r requirements-doc.txt
115+
$ pip install -r docs/requirements.txt
116116
117117
Then run
118118

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Diff for: doc/conf.py renamed to docs/source/conf.py

File renamed without changes.
File renamed without changes.

Diff for: doc/index.rst renamed to docs/source/index.rst

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)