Metadata-Version: 2.4
Name: sphinx-ford
Version: 0.1.0
Summary: Sphinx domain for Fortran with FORD bridge
License-Expression: Apache-2.0
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sphinx>=6.0
Provides-Extra: auto
Requires-Dist: ford>=6.1; extra == "auto"
Requires-Dist: markdown-it-py>=3.0; extra == "auto"
Provides-Extra: test
Requires-Dist: pytest>=7.0; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx-book-theme; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: ford>=6.1; extra == "docs"
Requires-Dist: markdown-it-py>=3.0; extra == "docs"
Requires-Dist: fypp; extra == "docs"
Dynamic: license-file

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:

```bash
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:

```python
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:

```python
ford_project_file = "docs.md"
```

To automatically document your Fortran code

```rst
.. f:automodule:: physics
```

License
-------

This project is avaialble under an Apache 2.0 license. See the LICENSE file for details.
