pandas-sphinx
Render a pandas DataFrame as an opinionated table for Sphinx.
- Documentation: https://joaopalmeiro.github.io/pandas-sphinx/
- Source code: https://github.com/joaopalmeiro/pandas-sphinx
- Python package: https://pypi.org/project/pandas-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
- Sphinx:
- https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#tables
- https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks
- https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block
- https://pygments.org/docs/lexers/#lexers-for-various-shells
- https://raw.githubusercontent.com/readthedocs/sphinx_rtd_theme/master/docs/index.rst
- 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
- Documentation:
- https://numpydoc.readthedocs.io/en/stable/format.html + https://numpydoc.readthedocs.io/en/stable/example.html
- https://cjolowicz.github.io/posts/hypermodern-python-05-documentation/
- https://cjolowicz.github.io/posts/hypermodern-python-06-ci-cd/
- https://nashpy.readthedocs.io/en/stable/contributing/discussion/darglint/index.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 --inithatch env create(defaultenvironment) +hatch shell+pip show pandas-sphinx+pip listhatch env removeorhatch env remove formathatch env create formathatch run format:i+hatch run format:bhatch env prunehatch env showhatch shell+python dev.py+exitorhatch run python dev.pyhatch version minororhatch version patchhatch versionhatch run lint:i+hatch run lint:ib+hatch run lint:dhatch -e lint run darglint --helprm -rf dist/+hatch buildhatch publish --helphatch env create docshatch run docs:checkhatch -e format run rstfmt --helphatch run docs:build+hatch run docs:openhatch run docs:cleanhatch run docs:clean && hatch run docs:build && hatch run docs:open
- https://pycqa.github.io/isort/docs/configuration/black_compatibility.html
- Check if docstrings exist with interrogate, check their format with darglint
1 maintainer
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.1.tar.gz
(4.0 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pandas_sphinx-0.1.1.tar.gz.
File metadata
- Download URL: pandas_sphinx-0.1.1.tar.gz
- Upload date:
- Size: 4.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
python-httpx/0.23.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
963d72a88576974b257c6114c81088d4a28835358c555caf075dd61ad4d5c055
|
|
| MD5 |
aaf6af1fb69e82f92a5f03bb06eb3b3b
|
|
| BLAKE2b-256 |
8b19a492cb508205d202a097393efa59b9de43f69bbf17cb24579bd248ff78bc
|
File details
Details for the file pandas_sphinx-0.1.1-py3-none-any.whl.
File metadata
- Download URL: pandas_sphinx-0.1.1-py3-none-any.whl
- Upload date:
- Size: 4.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
python-httpx/0.23.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
80e6373c81ab36540b8c43881feec666149b8cfc7800049882c7872271282375
|
|
| MD5 |
f1eaf60c3a8813d7667ad11e7f4a3ef3
|
|
| BLAKE2b-256 |
35ee83b92da65d7898a9e213fa5f6de4a4f56d206bcf033d20c311e56a04f8b0
|
