=============
zzzeeksphinx
=============
This is zzzeek's own Sphinx layout, used by SQLAlchemy.
This layout is first and foremost pulled in for the SQLAlchemy documentation
builds (and possibly other related projects).
.. note:: The stability of zzzeeksphinx is **not** guaranteed and APIs and
behaviors can change at any time. For use in other projects, please fork
and/or adapt any portion of useful code as needed.
Features include:
* Uses Mako templates instead of Jinja, for more programmatic capabilities
inside of templates.
* Layout includes an independently scrollable sidebar
* A unique (to Sphinx) "contextual" sidebar contents that shows the
current page in context with all sibling pages (like that of MySQL's docs).
This is a form of TOC that Sphinx doesn't typically have a lot of
capability to do (well it could, with some simple feature adds), but
IMO this kind of navigation is critical for very large and nested
documentation sets, so that the navbar stays relatively small yet provides
context as to where you are in the docs and what else is locally available.
* Modifications to autodoc which illustrate inherited classes, bases,
method documentation illustrates if a method is only inherited from the
base or overridden.
* A "dynamic base" feature that will, under ReadTheDocs, pull in optional
``.mako`` and ``.py`` files from the website of your choice
that will serve as an alternate base template and a source of extra
config setup, respectively, allowing the layout to be integrated into
the layout of an external site when viewing on the web.
* A "viewsource" extension that can provide highlighted sourcecode to any
Python file arbitrarily.
* SQLAlchemy-specific stuff, like the [SQL] popups, the dialect info
directives.
* scss support using pyscss.
Config
======
in conf.py, the extension is::
extensions = [
'zzzeeksphinx',
]
The theme is::
html_theme = 'zzzeeksphinx'
Other configs that SQLAlchemy has set up; these two are probably
needed::
# The short X.Y version.
version = "1.0"
# The full version, including alpha/beta/rc tags.
release = "1.0.0"
release_date = "Not released"
Additional configs for the "dynamic site thing" look like::
site_base = os.environ.get("RTD_SITE_BASE", "http://www.sqlalchemy.org")
site_adapter_template = "docs_adapter.mako"
site_adapter_py = "docs_adapter.py"
Configs which do some last-minute translation of module names
when running autodoc to display API documentation::
autodocmods_convert_modname = {
"sqlalchemy.sql.sqltypes": "sqlalchemy.types",
"sqlalchemy.sql.type_api": "sqlalchemy.types",
"sqlalchemy.sql.schema": "sqlalchemy.schema",
"sqlalchemy.sql.elements": "sqlalchemy.sql.expression",
"sqlalchemy.sql.selectable": "sqlalchemy.sql.expression",
"sqlalchemy.sql.dml": "sqlalchemy.sql.expression",
"sqlalchemy.sql.ddl": "sqlalchemy.schema",
"sqlalchemy.sql.base": "sqlalchemy.sql.expression"
}
autodocmods_convert_modname_w_class = {
("sqlalchemy.engine.interfaces", "Connectable"): "sqlalchemy.engine",
("sqlalchemy.sql.base", "DialectKWArgs"): "sqlalchemy.sql.base",
}
Raw data
{
"_id": null,
"home_page": "https://github.com/sqlalchemyorg/zzzeeksphinx",
"name": "zzzeeksphinx",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Sphinx",
"author": "Mike Bayer",
"author_email": "mike@zzzcomputing.com",
"download_url": "https://files.pythonhosted.org/packages/a4/6f/5a0499185d0d7ffc3b94d187f52f8e8cf233ae525eff304631980e3a3d63/zzzeeksphinx-1.5.0.tar.gz",
"platform": null,
"description": "=============\nzzzeeksphinx\n=============\n\nThis is zzzeek's own Sphinx layout, used by SQLAlchemy.\n\nThis layout is first and foremost pulled in for the SQLAlchemy documentation\nbuilds (and possibly other related projects).\n\n.. note:: The stability of zzzeeksphinx is **not** guaranteed and APIs and\n behaviors can change at any time. For use in other projects, please fork\n and/or adapt any portion of useful code as needed.\n\nFeatures include:\n\n* Uses Mako templates instead of Jinja, for more programmatic capabilities\n inside of templates.\n\n* Layout includes an independently scrollable sidebar\n\n* A unique (to Sphinx) \"contextual\" sidebar contents that shows the\n current page in context with all sibling pages (like that of MySQL's docs).\n This is a form of TOC that Sphinx doesn't typically have a lot of\n capability to do (well it could, with some simple feature adds), but\n IMO this kind of navigation is critical for very large and nested\n documentation sets, so that the navbar stays relatively small yet provides\n context as to where you are in the docs and what else is locally available.\n\n* Modifications to autodoc which illustrate inherited classes, bases,\n method documentation illustrates if a method is only inherited from the\n base or overridden.\n\n* A \"dynamic base\" feature that will, under ReadTheDocs, pull in optional\n ``.mako`` and ``.py`` files from the website of your choice\n that will serve as an alternate base template and a source of extra\n config setup, respectively, allowing the layout to be integrated into\n the layout of an external site when viewing on the web.\n\n* A \"viewsource\" extension that can provide highlighted sourcecode to any\n Python file arbitrarily.\n\n* SQLAlchemy-specific stuff, like the [SQL] popups, the dialect info\n directives.\n\n* scss support using pyscss.\n\n\nConfig\n======\n\nin conf.py, the extension is::\n\n extensions = [\n 'zzzeeksphinx',\n ]\n\nThe theme is::\n\n html_theme = 'zzzeeksphinx'\n\nOther configs that SQLAlchemy has set up; these two are probably\nneeded::\n\n # The short X.Y version.\n version = \"1.0\"\n # The full version, including alpha/beta/rc tags.\n release = \"1.0.0\"\n\n release_date = \"Not released\"\n\nAdditional configs for the \"dynamic site thing\" look like::\n\n site_base = os.environ.get(\"RTD_SITE_BASE\", \"http://www.sqlalchemy.org\")\n site_adapter_template = \"docs_adapter.mako\"\n site_adapter_py = \"docs_adapter.py\"\n\nConfigs which do some last-minute translation of module names\nwhen running autodoc to display API documentation::\n\n autodocmods_convert_modname = {\n \"sqlalchemy.sql.sqltypes\": \"sqlalchemy.types\",\n \"sqlalchemy.sql.type_api\": \"sqlalchemy.types\",\n \"sqlalchemy.sql.schema\": \"sqlalchemy.schema\",\n \"sqlalchemy.sql.elements\": \"sqlalchemy.sql.expression\",\n \"sqlalchemy.sql.selectable\": \"sqlalchemy.sql.expression\",\n \"sqlalchemy.sql.dml\": \"sqlalchemy.sql.expression\",\n \"sqlalchemy.sql.ddl\": \"sqlalchemy.schema\",\n \"sqlalchemy.sql.base\": \"sqlalchemy.sql.expression\"\n }\n\n autodocmods_convert_modname_w_class = {\n (\"sqlalchemy.engine.interfaces\", \"Connectable\"): \"sqlalchemy.engine\",\n (\"sqlalchemy.sql.base\", \"DialectKWArgs\"): \"sqlalchemy.sql.base\",\n }\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Zzzeek's Sphinx Layout and Utilities.",
"version": "1.5.0",
"project_urls": {
"Homepage": "https://github.com/sqlalchemyorg/zzzeeksphinx"
},
"split_keywords": [
"sphinx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a46f5a0499185d0d7ffc3b94d187f52f8e8cf233ae525eff304631980e3a3d63",
"md5": "9f821a1fa3a156dd1a4a6c0f4677de50",
"sha256": "aeeb6f9db316503708373c5a8fc06256cb601ee4f6855867e158fc13a0ec377a"
},
"downloads": -1,
"filename": "zzzeeksphinx-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "9f821a1fa3a156dd1a4a6c0f4677de50",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 104539,
"upload_time": "2024-02-29T21:35:09",
"upload_time_iso_8601": "2024-02-29T21:35:09.033395Z",
"url": "https://files.pythonhosted.org/packages/a4/6f/5a0499185d0d7ffc3b94d187f52f8e8cf233ae525eff304631980e3a3d63/zzzeeksphinx-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-29 21:35:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sqlalchemyorg",
"github_project": "zzzeeksphinx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "zzzeeksphinx"
}
JSON
