Skip to content

Commit 157bd10

Browse files
committed
Fix failed readthedocs build
1 parent d2f3e85 commit 157bd10

6 files changed

Lines changed: 34 additions & 30 deletions

File tree

.readthedocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,5 @@ python:
2020
install:
2121
- method: pip
2222
path: .
23+
extra_requirements:
24+
- doc

doc/source/api.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,71 +3,71 @@
33
API
44
===
55

6-
scWAE
7-
-----
6+
DISCERN
7+
-------
88

9-
.. automodule:: scwae
9+
.. automodule:: discern
1010
:members:
1111
:inherited-members:
1212

13-
Batch correction functions
14-
--------------------------
13+
Reconstruction functions
14+
------------------------
1515

16-
.. automodule:: scwae.estimators
16+
.. automodule:: discern.estimators
1717
:members:
1818
:inherited-members:
1919

20-
.. automodule:: scwae.estimators.batch_integration
20+
.. automodule:: discern.estimators.batch_integration
2121
:members:
2222
:inherited-members:
2323

24-
.. automodule:: scwae.estimators.callbacks
24+
.. automodule:: discern.estimators.callbacks
2525
:members:
2626
:inherited-members:
2727

28-
.. automodule:: scwae.estimators.customlayers
28+
.. automodule:: discern.estimators.customlayers
2929
:members:
3030

31-
.. automodule:: scwae.estimators.losses
31+
.. automodule:: discern.estimators.losses
3232
:members:
3333
:inherited-members:
3434

35-
.. automodule:: scwae.estimators.run_exp
35+
.. automodule:: discern.estimators.run_exp
3636
:members:
3737
:inherited-members:
3838

39-
.. automodule:: scwae.estimators.utilities_wae
39+
.. automodule:: discern.estimators.utilities_wae
4040
:members:
4141
:inherited-members:
4242

4343
I/O functions
4444
-------------
4545

46-
.. automodule:: scwae.io
46+
.. automodule:: discern.io
4747
:members:
4848

4949
Preprocessing functions
5050
-----------------------
5151

5252

53-
.. automodule:: scwae.preprocessing
53+
.. automodule:: discern.preprocessing
5454
:members:
5555
:inherited-members:
5656

5757
Online/Incremental learning
5858
---------------------------
5959

60-
.. automodule:: scwae.online_learning
60+
.. automodule:: discern.online_learning
6161
:members:
6262
:inherited-members:
6363

6464
Other functions
6565
---------------
6666

67-
.. automodule:: scwae.functions
67+
.. automodule:: discern.functions
6868
:members:
6969
:inherited-members:
7070

71-
.. automodule:: scwae.mmd
71+
.. automodule:: discern.mmd
7272
:members:
7373
:inherited-members:

doc/source/conf.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@
1010
# add these directories to sys.path here. If the directory is relative to the
1111
# documentation root, use os.path.abspath to make it absolute, like shown here.
1212
#
13-
import os
13+
import pathlib
1414
import sys
15-
sys.path.insert(0, os.path.abspath('../..'))
15+
rootpath = pathlib.Path(__file__).parents[2].resolve()
16+
sys.path.insert(0, rootpath.as_posix())
1617
import sphinx_rtd_theme
1718
import toml
1819

19-
with open("../../pyproject.toml") as file:
20+
with rootpath.joinpath("pyproject.toml").open("r") as file:
2021
args = toml.load(file)["tool"]["poetry"]
2122

2223

doc/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
contain the root `toctree` directive.
55
66
Welcome to DISCERN's documentation!
7-
=================================
7+
===================================
88

99
.. toctree::
1010
:maxdepth: 2

poetry.lock

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ joblib = "^1.0.1"
2525
click = "^7.1.2"
2626
Sphinx = {version = "^4.1.1", optional = true}
2727
sphinx-rtd-theme = {version = "^0.5.2", optional = true}
28+
toml = {version = "^0.10.2", optional = true}
2829

2930
[tool.poetry.dev-dependencies]
3031
ray = {extras = ["debug"], version = ">=1.6.0,<1.7.0"}
@@ -42,7 +43,7 @@ rstcheck = {version = "^3.3.1", optional = true}
4243

4344
[tool.poetry.extras]
4445
jupyter = ["ipykernel"]
45-
doc = ["Sphinx", "rstcheck","sphinx_rtd_theme"]
46+
doc = ["Sphinx", "rstcheck","sphinx_rtd_theme","toml"]
4647

4748
[tool.poetry.scripts]
4849
merge_parameter = "discern._scripts.merge_parameters:main"
@@ -51,7 +52,7 @@ discern = "discern.__main__:main"
5152
[tool.pylint.messages_control]
5253
disable = "import-error"
5354
[build-system]
54-
requires = ["poetry_core>=1.0.0","Cython", "numpy<1.20.0"]
55+
requires = ["poetry_core>=1.0.0","Cython", "numpy<1.20.0","setuptools"]
5556
build-backend = "poetry.core.masonry.api"
5657

5758
[tool.vulture]

0 commit comments

Comments
 (0)