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
17 changes: 17 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this is building version 2.0.0. The version: 2 on line 4 refers to the ReadTheDocs configuration file format version (not PHATE version). The actual PHATE version being documented is determined by what's in the code - Python/phate/version.py shows __version__ = "2.0.0". The built documentation correctly shows "PHATE 2.0.0" and includes the random_landmarking parameter.


# Build documentation in the Python/doc directory
sphinx:
configuration: Python/doc/source/conf.py

# Python version and requirements
python:
version: "3.11"
install:
- method: pip
path: Python
- method: pip
requirements: Python/doc/source/requirements.txt
2 changes: 1 addition & 1 deletion Python/doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down
1 change: 0 additions & 1 deletion Python/doc/source/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
./Python
sphinx
sphinxcontrib-napoleon
Loading