Skip to content

Commit f5728c1

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 54f82e8 commit f5728c1

35 files changed

+3
-3
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
@@ -114,7 +114,7 @@ To build documentation, first you must install its build requirements:
114114

115115
.. code-block:: bash
116116
117-
$ pip install -r requirements-doc.txt
117+
$ pip install -r docs/requirements.txt
118118
119119
To build with valid version, `tarantool` package must be installed before
120120
documentation build.
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

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
# sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath('.')), "src"))
1818

1919
# Read package version without importing it
20-
for line in open(os.path.join(os.path.dirname(os.path.abspath('.')), "tarantool", "__init__.py")):
20+
for line in open(os.path.join(os.path.dirname(os.path.dirname(os.path.abspath('.'))), "tarantool", "__init__.py")):
2121
if line.startswith("__version__"):
2222
exec(line)
2323
break
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)