Render a pandas DataFrame as an opinionated table for Sphinx.
Project description
pandas-sphinx
Render a pandas DataFrame as an opinionated table for Sphinx.
References
- https://github.com/yehoshuadimarsky/bcpandas#quickstart
- https://github.com/yehoshuadimarsky/bcpandas/blob/master/bcpandas/main.py#L309
- https://github.com/Zsailer/pandas_flavor
- https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#tables
- https://github.com/astanin/python-tabulate#table-format
- https://en.wikipedia.org/wiki/Ellipsis
- https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.to_markdown.html
- https://github.com/pandas-dev/pandas/blob/v1.1.0/pandas/core/frame.py#L2240
- https://pandas.pydata.org/pandas-docs/version/1.3/reference/api/pandas.DataFrame.to_markdown.html
- https://github.com/koaning/scikit-bloom/blob/main/setup.py
- https://github.com/scikit-hep/cookie
- https://numpydoc.readthedocs.io/en/stable/format.html + https://numpydoc.readthedocs.io/en/stable/example.html
Notes
- https://hatch.pypa.io/latest/install/:
brew update
+brew install hatch
+hatch --version
- Tabulate:
- The minimum column size is 2 (+ 2 padding spaces): https://github.com/gregbanks/python-tabulate/blob/master/tabulate.py#L791
- https://github.com/gregbanks/python-tabulate/blob/master/tabulate.py#L132
- Hatch:
hatch new --init
hatch env create
(default
environment) +hatch shell
+pip show pandas-sphinx
+pip list
hatch env remove
orhatch env remove format
hatch env create format
hatch run format:i
+hatch run format:b
hatch env prune
hatch env show
hatch shell
+python dev.py
+exit
hatch version minor
orhatch version patch
hatch version
hatch run lint:i
+hatch run lint:ib
rm -rf dist/
+hatch build
hatch publish --help
- https://pycqa.github.io/isort/docs/configuration/black_compatibility.html
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pandas_sphinx-0.1.0.tar.gz
(3.3 kB
view hashes)
Built Distribution
Close
Hashes for pandas_sphinx-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e5417d616ddf1acba815c11e806f16dcc5706fa7ecb94197f049b8071f9c803 |
|
MD5 | 96558d67f11e0151157f2ec3ff9c4571 |
|
BLAKE2b-256 | d6fcb494e6710189b6a5a21c63a1c22002144106453c78fa21794f7de5c3d1da |