Skip to content

Commit

Permalink
docs: Normalize conf.py
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Jun 13, 2023
1 parent 8ada219 commit b691dbf
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 26 deletions.
48 changes: 25 additions & 23 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,40 +1,42 @@
#!/usr/bin/env python

# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import os
import sys

# Path munging
sys.path.insert(0, os.path.abspath('..'))

# Extensions
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'agate'
copyright = '2017, Christopher Groskopf'
version = '1.7.1'
release = version

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
'sphinx.ext.autosummary',
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx'
]
# autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'show-inheritance']

intersphinx_mapping = {
'python': ('https://docs.python.org/3.11', None),
'leather': ('http://leather.readthedocs.io/en/latest/', None)
}

# Templates
templates_path = ['_templates']
master_doc = 'index'

# Metadata
project = 'agate'
copyright = '2017, Christopher Groskopf'
version = '1.7.1'
release = version
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

exclude_patterns = ['_build']
pygments_style = 'sphinx'
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

# HTMl theming
html_theme = 'furo'

html_static_path = ['_static']
htmlhelp_basename = 'agatedoc'

autodoc_default_flags = ['members', 'show-inheritance']

intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
'leather': ('http://leather.readthedocs.io/en/latest/', None)
}
1 change: 0 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@
],
'docs': [
'Sphinx>=1.2.2',
'sphinx_rtd_theme>=0.1.6',
],
}
)
4 changes: 2 additions & 2 deletions tutorial.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@
"All four of these objects are examples of [`.MappedSequence`](https://agate.readthedocs.io/en/latest/api/columns_and_rows.html#agate.MappedSequence), the foundational type that underlies much of agate's functionality. A MappedSequence functions very similar to a standard Python [`dict`](https://docs.python.org/3/tutorial/datastructures.html#dictionaries), with a few important exceptions:\n",
"\n",
"* Data may be accessed either by numeric index (e.g. column number) or by a non-integer key (e.g. column name).\n",
"* Items are ordered, just like an instance of [`collections.OrderedDict`](https://docs.python.org/3.5/library/collections.html#collections.OrderedDict).\n",
"* Items are ordered, just like an instance of [`collections.OrderedDict`](https://docs.python.org/3/library/collections.html#collections.OrderedDict).\n",
"* Iterating over the sequence returns its *values*, rather than its *keys*.\n",
"\n",
"To demonstrate the first point, these two lines are both valid ways of getting the first column in the `exonerations` table:"
Expand Down Expand Up @@ -304,7 +304,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"In this case we create our row names using a [`lambda`](https://docs.python.org/3/tutorial/controlflow.html#lambda-expressions) function that takes a row and returns an unique identifer. If your data has a unique column, you can also just pass the column name. (For example, a column of USPS abbrevations or FIPS codes.) Note, however, that your row names can never be `int`, because that is reserved for indexing by numeric order. (A [`decimal.Decimal`](https://docs.python.org/3.5/library/decimal.html#decimal.Decimal) or stringified integer is just fine.)\n",
"In this case we create our row names using a [`lambda`](https://docs.python.org/3/tutorial/controlflow.html#lambda-expressions) function that takes a row and returns an unique identifer. If your data has a unique column, you can also just pass the column name. (For example, a column of USPS abbrevations or FIPS codes.) Note, however, that your row names can never be `int`, because that is reserved for indexing by numeric order. (A [`decimal.Decimal`](https://docs.python.org/3/library/decimal.html#decimal.Decimal) or stringified integer is just fine.)\n",
"\n",
"Once you've got a specific row, you can then access its individual values (cells, in spreadsheet-speak) either by numeric index or column name:"
]
Expand Down

0 comments on commit b691dbf

Please sign in to comment.