Skip to main content

MartinPdeS-docs

Shared Sphinx defaults for the MartinPdeS scientific Python repositories.

The package intentionally uses a flat layout. A project keeps its own documentation content and assets, while this package supplies common Sphinx extensions, theme defaults, responsive layout settings, and gallery behavior. It also provides the shared author metadata, autodoc defaults, document defaults, theme navigation, repository links, version switcher, and output metadata used across the package family.

In a project's docs/source/conf.py:

from martinpdes_docs import configure

globals().update(
    configure(
        project="PackLab",
        package="PackLab",
        repository="MartinPdeS/PackLab",
        logo="_static/logo.png",
        favicon="_static/favicon.png",
    )
)

Project-specific values can be assigned below this call to override any shared default.

Set version="auto" to read __version__ from the importable package's _version.py without importing its __init__.py. This sets both Sphinx's version and release fields and the version switcher, and takes precedence over the tag environment variable. The package must be importable and its _version.py must provide a non-empty version string. With prefer_installed_package=True, discovery follows the same package search order used for documentation imports. Omitting version retains the existing environment and distribution-metadata fallback.

For a multi-section Sphinx-Gallery, pass the section names instead of repeating the directory mappings:

globals().update(
    configure(
        project="FlowCyPy",
        package="FlowCyPy",
        repository="MartinPdeS/FlowCyPy",
        gallery_sections=["tutorials", "studies", "validation"],
        gallery_default_thumb="_static/gallery-default.png",
    )
)

Use gallery_options for project-specific Sphinx-Gallery settings such as an additional image scraper or an example error policy.

For packages with compiled extensions, set prefer_installed_package=True so documentation builds import the installed wheel instead of the source checkout.

The shared configuration also owns the common dark-mode context, CSS files, autodoc defaults, and navigation metadata. Add only project-specific values in conf.py, for example:

globals().update(
    configure(
        project="SuPyMode",
        package="SuPyMode",
        repository="MartinPdeS/SuPyMode",
        extension_additions=["pyvista.ext.plot_directive"],
        html_css_files=["layout.css"],
        autodoc_default_options={"members": True},
        logo_text="",
    )
)

Use include_gallery=False for documentation sites without executable examples. The default theme, context, CSS, and extension set then remain centralized in this package.

Metadata

Release files for MartinPdeS-docs 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for MartinPdeS-docs 0.4.0
File Size Uploaded Provenance Actions
martinpdes_docs-0.4.0.tar.gz 8.6 kB Without provenance Details for martinpdes_docs-0.4.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for MartinPdeS-docs 0.4.0
File Interpreter ABI Platform Actions
martinpdes_docs-0.4.0-py3-none-any.whl Python 3 none any Details for martinpdes_docs-0.4.0-py3-none-any.whl

Total release size: 16.7 kB

Release files / martinpdes_docs-0.4.0.tar.gz

Download URL martinpdes_docs-0.4.0.tar.gz
Size 8.6 kB
Tags Source
SHA-256 checksum
How to use checksums
62db539d39f8fefc5069bae58daf2d1f6c383d504c9c8c063f8f55ed60bf6dd2
BLAKE2b-256 checksum
How to use checksums
02e6b7ce4f29b14abc0ee8c60b43b62651ce5965e740ec96d655760ecd02c246
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / martinpdes_docs-0.4.0-py3-none-any.whl

Download URL martinpdes_docs-0.4.0-py3-none-any.whl
Size 8.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1ae07e857999b671d6f8536387ba0447ffcb842cb87ebe63ea80c7b525ffabbf
BLAKE2b-256 checksum
How to use checksums
444b263d42e882c6a8a6a57385d4595d297b5e81076a8552e956113b89d60e61
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Security for MartinPdeS-docs 0.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page