Sphinx-FORD bridge
This repository contains the sphinx-ford bridge. It provides a Sphinx domain for documenting Fortran code and the possibility to generate documentation automatically from FORD projects.
Installation
Install the package from PyPI:
pip install sphinx-ford[auto]
Usage
To use the sphinx-ford bridge, add sphinx_ford to the extensions list in your Sphinx conf.py file:
extensions = [
'sphinx_ford',
# other extensions...
]
This will enable the Fortran domain and allow you to use the provided directives and roles to document your Fortran code.
Add your FORD project to the Sphinx configuration:
ford_project_file = "docs.md"
To automatically document your Fortran code
.. f:automodule:: physics
License
This project is avaialble under an Apache 2.0 license. See the LICENSE file for details.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-ford 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| sphinx_ford-0.1.0.tar.gz | 41.2 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_ford-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 73.0 kB
Release files / sphinx_ford-0.1.0.tar.gz
| Download URL | sphinx_ford-0.1.0.tar.gz |
|---|---|
| Size | 41.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5f678a22fd62c69dc8558ab0e840fc42e6b2b58c7fb351dbb5e2061d7b20521c
|
|
BLAKE2b-256 checksum How to use checksums |
636cc4cb5d76e35763d9160eb334b84daa20d2df775edd8f13ea21736a778daf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 5, 2026.
Transparency logRelease files / sphinx_ford-0.1.0-py3-none-any.whl
| Download URL | sphinx_ford-0.1.0-py3-none-any.whl |
|---|---|
| Size | 31.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
29c25dc93b1fbd86be0ff2085b2e9c31f88ef154af9c9fa0a5de9e6b5bbd4cef
|
|
BLAKE2b-256 checksum How to use checksums |
98e454f98c7577271f4ebd69fedd239ef48e3aebfa23e8764e1f7fa14a192321
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 5, 2026.
Transparency logSecurity for sphinx-ford 0.1.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.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for sphinx_ford-0.1.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 5, 2026.
Transparency logA 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.
