Skip to content

Commit f13d4ae

Browse files
A problem with documentation is fixed [Sphinx]
--- It seems Sphinx does not support our new project structure. So we will process an installed "instance" of testgres but not its source code.
1 parent ebe8a08 commit f13d4ae

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

docs/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,5 @@ help:
1717
# Catch-all target: route all unknown targets to Sphinx using the new
1818
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1919
%: Makefile
20+
@pip install --force-reinstall ..
2021
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/source/conf.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,19 @@
1414
#
1515
import os
1616
import sys
17-
sys.path.insert(0, os.path.abspath('../..'))
17+
import testgres
18+
19+
assert testgres.__path__ is not None
20+
assert len(testgres.__path__) == 1
21+
assert type(testgres.__path__[0] == str) # noqa: E721
22+
p = os.path.dirname(testgres.__path__[0])
23+
assert type(p) == str # noqa: E721
24+
sys.path.insert(0, os.path.abspath(p))
1825

1926
# -- Project information -----------------------------------------------------
2027

2128
project = u'testgres'
29+
package_name = u'testgres'
2230
copyright = u'2016-2023, Postgres Professional'
2331
author = u'Postgres Professional'
2432

@@ -55,7 +63,7 @@
5563
#
5664
# This is also used if you do content translation via gettext catalogs.
5765
# Usually you set "language" from the command line for these cases.
58-
language = None
66+
language = "en"
5967

6068
# List of patterns, relative to source directory, that match files and
6169
# directories to ignore when looking for source files.

0 commit comments

Comments
 (0)