diff --git a/docs/books.bib b/docs/books.bib new file mode 120000 index 0000000..a26f67f --- /dev/null +++ b/docs/books.bib @@ -0,0 +1 @@ +c:/s/telos/biblio/books.bib \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 10b984c..8fa963d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -5,6 +5,9 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html # -- Path setup -------------------------------------------------------------- +import pandas as pd +import greater_tables as gter + # 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 @@ -17,12 +20,12 @@ # -- Project information ----------------------------------------------------- -project = 'greater_tables' +project = gter.__project__ copyright = '2025, Stephen J Mildenhall' -author = 'Stephen J Mildenhall' +author = gter.__author__ # The full version, including alpha/beta/rc tags -release = '1.0.0' +release = gter.__version__ # -- General configuration --------------------------------------------------- @@ -30,8 +33,24 @@ release = '1.0.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. +# same as aggregate extensions = [ -] + 'sphinx_rtd_theme', + 'sphinx.ext.autodoc', + 'sphinx.ext.todo', + 'sphinx.ext.mathjax', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages', + 'sphinx.ext.autosectionlabel', + 'sphinx_copybutton', + 'sphinx_toggleprompt', + 'IPython.sphinxext.ipython_directive', + 'IPython.sphinxext.ipython_console_highlighting', + 'nbsphinx', + 'sphinx_panels', + 'sphinxcontrib.bibtex', + 'sphinx_multitoc_numbering', + 'sphinx_rtd_dark_mode'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -42,14 +61,45 @@ templates_path = ['_templates'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +# The master toctree document. +master_doc = 'index' + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# GPT suggestions for the reference problem +autonumbering_enabled = True + +# bibtex options +bibtex_bibfiles = ['library.bib', 'books.bib'] +bibtex_reference_style = 'author_year' + +# user starts in light mode +default_dark_mode = False + + # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' + +html_theme_options = { + 'logo_only': False, + 'display_version': True, + 'prev_next_buttons_location': 'both', + 'style_external_links': False, + 'collapse_navigation': True, + 'sticky_navigation': True, + 'navigation_depth': 3, + 'includehidden': True, + 'titles_only': False, +} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] \ No newline at end of file +html_static_path = ['_static'] + +# down the road - get tex docs from aggregate diff --git a/docs/index.rst b/docs/index.rst index d0f8b91..cf94f1a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,3 +18,35 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` + + +Introduction +============ + +All about greater_tables. + + +``greater_tables`` Class +========================= + +.. autoclass:: greater_tables.GT + :members: + :undoc-members: + :show-inheritance: + :private-members: + +.. automodule:: greater_tables + :members: + :undoc-members: + :show-inheritance: + :private-members: + +Utilties +======== + +.. automodule:: greater_tables.utilities + :members: + :undoc-members: + :show-inheritance: + :private-members: + diff --git a/docs/library.bib b/docs/library.bib new file mode 120000 index 0000000..33eef7a --- /dev/null +++ b/docs/library.bib @@ -0,0 +1 @@ +c:/s/telos/biblio/library.bib \ No newline at end of file diff --git a/docs/start-server.bat b/docs/start-server.bat new file mode 100644 index 0000000..b29a7c2 --- /dev/null +++ b/docs/start-server.bat @@ -0,0 +1,5 @@ +pushd _build\html + +start python -m http.server 9988 + +popd diff --git a/docs/style.csl b/docs/style.csl new file mode 120000 index 0000000..e80700d --- /dev/null +++ b/docs/style.csl @@ -0,0 +1 @@ +c:/s/telos/biblio/journal-of-risk-and-uncertainty.csl \ No newline at end of file diff --git a/greater_tables/__init__.py b/greater_tables/__init__.py index 59e7404..a5d9e55 100644 --- a/greater_tables/__init__.py +++ b/greater_tables/__init__.py @@ -1,4 +1,6 @@ -__version__ = '1.0.0' +__version__ = '1.1.0' +__project__ = 'greater_tables' +__author__ = 'Stephen J Mildenhall' from . greater_tables import * from . utilities import * diff --git a/pyproject.toml b/pyproject.toml index 6cb6da7..b87195e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,15 +4,17 @@ build-backend = "setuptools.build_meta" [project] name = "greater_tables" -version = "1.0.0" description = "Perfect tables from pandas" authors = [{name = "Stephen J Mildehall", email = "mynl@me.com" }] readme = "README.md" license = { text = "MIT" } requires-python = ">=3.10" -dependencies = ["pandas"] +dependencies = ["pandas", "bs4"] classifiers = [ "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.10", ] + +[tool.setuptools.dynamic] +version = { attr = "greater_tables.__version__" } \ No newline at end of file