Skip to content

Commit

Permalink
Rtd update (#58)
Browse files Browse the repository at this point in the history
* Update read the docs config

*Update copyright year in docs

* Update python version

* Change build configuration

* Change version read in config

* Refactor config files

* Refactor api config
  • Loading branch information
rmontanana authored Aug 15, 2024
1 parent 517013b commit dc63701
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 22 deletions.
6 changes: 5 additions & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,12 @@ version: 2
sphinx:
configuration: docs/source/conf.py

build:
os: ubuntu-22.04
tools:
python: "3.12"

python:
version: 3.11
install:
- requirements: requirements.txt
- requirements: docs/requirements.txt
5 changes: 3 additions & 2 deletions docs/source/api/Siterator.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
Siterator
=========

.. automodule:: Splitter
.. automodule:: stree
.. autoclass:: Siterator
:members:
:undoc-members:
:private-members:
:show-inheritance:
:show-inheritance:
:noindex:
6 changes: 3 additions & 3 deletions docs/source/api/Snode.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Snode
=====

.. automodule:: Splitter
.. autoclass:: Snode
.. autoclass:: stree.Splitter.Snode
:members:
:undoc-members:
:private-members:
:show-inheritance:
:show-inheritance:
:noindex:
5 changes: 3 additions & 2 deletions docs/source/api/Splitter.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
Splitter
========

.. automodule:: Splitter
.. automodule:: stree.Splitter
.. autoclass:: Splitter
:members:
:undoc-members:
:private-members:
:show-inheritance:
:show-inheritance:
:noindex:
3 changes: 2 additions & 1 deletion docs/source/api/Stree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ Stree
:members:
:undoc-members:
:private-members:
:show-inheritance:
:show-inheritance:
:noindex:
17 changes: 6 additions & 11 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,21 @@

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
from stree._version import __version__
from pathlib import Path

sys.path.insert(0, str(Path(__file__).parent.parent.parent))

sys.path.insert(0, os.path.abspath("../../stree/"))
import stree

# -- Project information -----------------------------------------------------

project = "STree"
copyright = "2020 - 2022, Ricardo Montañana Gómez"
copyright = "2020 - 2024, Ricardo Montañana Gómez"
author = "Ricardo Montañana Gómez"

# The full version, including alpha/beta/rc tags
version = __version__
release = version

version = release = stree.__version__

# -- General configuration ---------------------------------------------------

Expand Down
1 change: 0 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Welcome to STree's documentation!
:caption: Contents:
:titlesonly:


stree
install
hyperparameters
Expand Down
2 changes: 1 addition & 1 deletion stree/_version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "1.4.1"
__version__ = "1.4.0"

0 comments on commit dc63701

Please sign in to comment.