Skip to content

Commit a973475

Browse files
author
Philippe Guglielmetti
committed
ReadTheDocs
1 parent 400669b commit a973475

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

_docs.bat

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
cls -C
2-
cd goulib
3-
call sphinx-apidoc . -eo ..\docs\modules
4-
cd ..
52
cd docs
3+
call sphinx-apidoc ..\Goulib -eo modules
64
del modules\Goulib.rst
75
del _build\html\index.html
86
call make html

docs/conf.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ def get_version():
4545
# If extensions (or modules to document with autodoc) are in another directory,
4646
# add these directories to sys.path here. If the directory is relative to the
4747
# documentation root, use os.path.abspath to make it absolute, like shown here.
48-
sys.path.insert(0, os.path.abspath('..'))
4948
sys.path.insert(0, os.path.abspath('modules'))
49+
sys.path.insert(0, os.path.abspath('..'))
5050

5151

5252
# -- General configuration -----------------------------------------------------
@@ -62,10 +62,10 @@ def get_version():
6262
'sphinx.ext.viewcode',
6363
'sphinx.ext.inheritance_diagram',
6464
'sphinx.ext.intersphinx',
65+
# 'sphinx.ext.napoleon',
6566
]
66-
67-
if not on_rtd:
68-
extensions.append('sphinx.ext.napoleon')
67+
68+
napoleon_include_special_with_doc = False
6969

7070
autosummary_generate = True
7171

@@ -100,7 +100,6 @@ def autodoc_skip_member(app, what, name, obj, skip, options):
100100
'__doc__', '__module__', '__dict__',
101101
)
102102
exclude = name in exclusions
103-
if exclude: print name
104103
return skip or exclude
105104

106105
def setup(app):

docs/modules/Goulib.geom3d.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Goulib.geom3d module
2+
====================
3+
4+
.. automodule:: Goulib.geom3d
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

0 commit comments

Comments
 (0)