Rtd update (#58)

* 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
This commit is contained in:
Ricardo Montañana Gómez
2024-08-15 11:49:38 +02:00
committed by GitHub
parent 517013be09
commit dc637018e8
8 changed files with 23 additions and 22 deletions

View File

@@ -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

View File

@@ -1,9 +1,10 @@
Siterator
=========
.. automodule:: Splitter
.. automodule:: stree
.. autoclass:: Siterator
:members:
:undoc-members:
:private-members:
:show-inheritance:
:show-inheritance:
:noindex:

View File

@@ -1,9 +1,9 @@
Snode
=====
.. automodule:: Splitter
.. autoclass:: Snode
.. autoclass:: stree.Splitter.Snode
:members:
:undoc-members:
:private-members:
:show-inheritance:
:show-inheritance:
:noindex:

View File

@@ -1,9 +1,10 @@
Splitter
========
.. automodule:: Splitter
.. automodule:: stree.Splitter
.. autoclass:: Splitter
:members:
:undoc-members:
:private-members:
:show-inheritance:
:show-inheritance:
:noindex:

View File

@@ -6,4 +6,5 @@ Stree
:members:
:undoc-members:
:private-members:
:show-inheritance:
:show-inheritance:
:noindex:

View File

@@ -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, os.path.abspath("../../stree/"))
sys.path.insert(0, str(Path(__file__).parent.parent.parent))
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 ---------------------------------------------------

View File

@@ -5,7 +5,6 @@ Welcome to STree's documentation!
:caption: Contents:
:titlesonly:
stree
install
hyperparameters

View File

@@ -1 +1 @@
__version__ = "1.4.1"
__version__ = "1.4.0"