mirror of
https://github.com/wassname/greater_tables_project.git
synced 2026-06-27 16:15:38 +08:00
Doc and pyproject setup
This commit is contained in:
Symlink
+1
@@ -0,0 +1 @@
|
||||
c:/s/telos/biblio/books.bib
|
||||
+56
-6
@@ -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']
|
||||
html_static_path = ['_static']
|
||||
|
||||
# down the road - get tex docs from aggregate
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
Symlink
+1
@@ -0,0 +1 @@
|
||||
c:/s/telos/biblio/library.bib
|
||||
@@ -0,0 +1,5 @@
|
||||
pushd _build\html
|
||||
|
||||
start python -m http.server 9988
|
||||
|
||||
popd
|
||||
Symlink
+1
@@ -0,0 +1 @@
|
||||
c:/s/telos/biblio/journal-of-risk-and-uncertainty.csl
|
||||
@@ -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 *
|
||||
|
||||
+4
-2
@@ -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__" }
|
||||
Reference in New Issue
Block a user