Sphinx domain for Fortran with FORD bridge
Project description
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
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 sphinx_ford-0.1.0.tar.gz.
File metadata
- Download URL: sphinx_ford-0.1.0.tar.gz
- Upload date:
- Size: 41.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5f678a22fd62c69dc8558ab0e840fc42e6b2b58c7fb351dbb5e2061d7b20521c
|
|
| MD5 |
26b779f33fcaf3500f4571053cb53323
|
|
| BLAKE2b-256 |
636cc4cb5d76e35763d9160eb334b84daa20d2df775edd8f13ea21736a778daf
|
Provenance
The following attestation bundles were made for sphinx_ford-0.1.0.tar.gz:
Publisher:
pypi.yml on awvwgk/sphinx-ford
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_ford-0.1.0.tar.gz -
Subject digest:
5f678a22fd62c69dc8558ab0e840fc42e6b2b58c7fb351dbb5e2061d7b20521c - Sigstore transparency entry: 1239449607
- Sigstore integration time:
-
Permalink:
awvwgk/sphinx-ford@0ece8cc0abcc00b3e6306102c89a01350d71fe11 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/awvwgk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi.yml@0ece8cc0abcc00b3e6306102c89a01350d71fe11 -
Trigger Event:
push
-
Statement type:
File details
Details for the file sphinx_ford-0.1.0-py3-none-any.whl.
File metadata
- Download URL: sphinx_ford-0.1.0-py3-none-any.whl
- Upload date:
- Size: 31.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
29c25dc93b1fbd86be0ff2085b2e9c31f88ef154af9c9fa0a5de9e6b5bbd4cef
|
|
| MD5 |
32d553d708b728cb834284c2cb368364
|
|
| BLAKE2b-256 |
98e454f98c7577271f4ebd69fedd239ef48e3aebfa23e8764e1f7fa14a192321
|
Provenance
The following attestation bundles were made for sphinx_ford-0.1.0-py3-none-any.whl:
Publisher:
pypi.yml on awvwgk/sphinx-ford
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_ford-0.1.0-py3-none-any.whl -
Subject digest:
29c25dc93b1fbd86be0ff2085b2e9c31f88ef154af9c9fa0a5de9e6b5bbd4cef - Sigstore transparency entry: 1239449608
- Sigstore integration time:
-
Permalink:
awvwgk/sphinx-ford@0ece8cc0abcc00b3e6306102c89a01350d71fe11 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/awvwgk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi.yml@0ece8cc0abcc00b3e6306102c89a01350d71fe11 -
Trigger Event:
push
-
Statement type:
