Documentation update: add readthedocs with sphinx #84

Merged

belsten merged 37 commits intomainfrom

Feb 7, 2025

Commits on Feb 7, 2025

add sphinx documentation code

belsten
authored and
belsten
committed
import sphinx and add readthedocs config yaml

belsten
authored and
belsten
committed
run apidoc post build

belsten
authored and
belsten
committed
require sparse coding repo install for documentation generation

belsten
authored and
belsten
committed
install package requirements to build docs

belsten
authored and
belsten
committed
autogenerate rst files to import

belsten
authored and
belsten
committed
make submodules importable

belsten
authored and
belsten
committed
change base from sparsecoding to modules

belsten
authored and
belsten
committed
apidoc output in generated dir

belsten
authored and
belsten
committed
change modules to sparsecoding

belsten
authored and
belsten
committed
docs are generated, however there are errors and when searching the generated docs, inference and models doesnt show up. Need to investigate this issue further

belsten
authored and
belsten
committed
change theme to rtd, generate API documentation with autodoc

belsten
authored and
belsten
committed
change python 3 to 3.7

belsten
authored and
belsten
committed
upload of install, contributing, and quickstart docs. quickstart doc still needs to be completed

belsten
authored and
belsten
committed
add quick intro to library

belsten
authored and
belsten
committed
add RCTN abbreviation

belsten
authored and
belsten
committed
add license info

belsten
authored and
belsten
committed
remove basic

belsten
authored and
belsten
committed
added structure of library. Note its not exacly correct. It reflects restructure proposed in recent issue.

belsten
authored and
belsten
committed
rename transformations

belsten
authored and
belsten
committed
delete unnecessary utils and init

belsten
authored and
belsten
committed
remove import from data and add imports of transfrom tools

belsten
authored and
belsten
committed
fixed typos and minor reword

belsten
authored and
belsten
committed
update readme to provide pointers to the readthedocs. delete obsolete contributing.md as updated material is now in the readthedocs

belsten
authored and
belsten
committed
remove accidental horizontal lines

belsten
authored and
belsten
committed
add documentation badge to readme

belsten
authored and
belsten
committed
flake8 docs

belsten
authored and
belsten
committed
upgrade python install for readthedocs to match that of setup.py

belsten
authored and
belsten
committed
moved base class documentation above __init__ such that sphinx autodocs finds it and generates it

belsten
authored and
belsten
committed
modified documentation to adhear to structure used in rest of repository

belsten
authored and
belsten
committed
make api documentation match new directory structure/file naming and exlude test files from autodocs

belsten
authored and
belsten
committed
flake

belsten
authored and
belsten
committed
again, moved triple quote docstring to after definition of class (as opposed to in the __init__)

belsten
authored and
belsten
committed
update contributing documentation to new testing framework (pytest). Improve details of submitting PRs. Add information for reveiwers on how to merge pull requests.

belsten
authored and
belsten
committed
Slight wording adjustment

belsten
authored and
belsten
committed
comment syntax adjustmented for consistancy

belsten
authored and
belsten
committed
install instructions using pyproject.toml
belsten
committed