Skip to content

Commit 2f14925

Browse files
authored
fix: Fix process of build documentation (#653)
* try if update python solve bug * add docs requirements to setup.cfg * fix configuration * bump docs requirements * fix code
1 parent 33ac6a0 commit 2f14925

3 files changed

Lines changed: 14 additions & 4 deletions

File tree

.readthedocs.yml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,17 @@ sphinx:
1616
# Optionally build your docs in additional formats such as PDF and ePub
1717
formats: all
1818

19+
build:
20+
os: ubuntu-20.04
21+
tools:
22+
python: "3.9"
23+
24+
1925
# Optionally set the version of Python and requirements required to build your docs
2026
python:
21-
version: 3.8
2227
install:
2328
- requirements: docs/requirements.txt
2429
- requirements: requirements/requirements_pyinstaller.txt
2530
- requirements: requirements/requirements_dev.txt
2631
- method: pip
27-
path: .
32+
path: .[docs]

package/PartSegCore/sphinx/auto_parameters.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ def can_document_member(cls, member: Any, membername: str, isattr: bool, parent:
3636
def document_members(self, all_members: bool = False) -> None:
3737
pass
3838

39-
def add_content(self, more_content: Any, no_docstring: bool = False) -> None:
40-
super().add_content(more_content, no_docstring)
39+
def add_content(self, more_content: Any, **kwargs) -> None:
40+
super().add_content(more_content, **kwargs)
4141
if not isinstance(self.object, Register):
4242
raise ValueError("Not Register object")
4343
source = "autogenerated"

setup.cfg

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,11 @@ accelerate =
9898
all =
9999
PyOpenGL-accelerate>=3.1.5
100100
PyQt5!=5.15.0,>=5.12.3
101+
docs =
102+
autodoc-pydantic==1.7.2
103+
sphinx!=3.0.0,!=3.5.0
104+
sphinx-autodoc-typehints==1.18.3
105+
sphinx-qt-documentation==0.4
101106
pyqt =
102107
PyQt5!=5.15.0,>=5.12.3
103108
pyqt5 =

0 commit comments

Comments
 (0)