Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
version: 2

build:
os: "ubuntu-24.04"
tools:
python: "miniconda3-3.12-24.9"

conda:
environment: conda/environment.yml

sphinx:
# Path to your Sphinx configuration file.
configuration: doc/conf.py
7 changes: 2 additions & 5 deletions conda/environment.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
name: stat_tool_dev
channels:
- conda-forge
- openalea3
- conda-forge
dependencies:
- python
- scikit-build-core
- setuptoools-scm
- setuptools
- cmake
- pip
- boost
- matplotlib-base
- pip
- pip:
- -e '..[test,dev,doc]'
2 changes: 1 addition & 1 deletion doc/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -769,7 +769,7 @@ FILE_PATTERNS =
# be searched for input files as well.
# The default value is: NO.

RECURSIVE = NO
RECURSIVE = YES

# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
Expand Down
13 changes: 3 additions & 10 deletions doc/README
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
To generate sphinx documentation:
To generate Doxygen documentation (C++)

1. go to root directory of this package
2. type "python setup.py build_sphinx"
3. type "python setup.py build_sphinx -b latex"
!! right now (April 2009), there is an issue in pshinx related to utf-8. Because we are using unicode, we need
2.type "python setup.py build_sphinx"
to fix manually the latex documents, switching from ut88 to utf8x in the preamble section.
type "doxgen Doxyfile" for stat_tool/doc/
The documentation is generated in stat_tool/doc/html


to generate the epydoc documentation:

epydoc --html -o stat_tool ../src/openalea/stat_tool/
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -154,4 +154,4 @@
),
]
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {"python": ("https://docs.python.org/", None)}
intersphinx_mapping = {"python": ("https://docs.python.org/", None)}
Loading
Loading