Metadata-Version: 2.4
Name: sphinxfortran_ng
Version: 0.6.0
Summary: An improved version of the sphinx-fortran python module
Author-email: Lorenzo Crippa <crippa.lorenzo@gmail.com>
Project-URL: Repository, https://github.com/SciFortran/sphinxfortran_ng
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# sphinxfortran_ng

[![PyPI](https://img.shields.io/pypi/v/sphinxfortran-ng.svg)](https://pypi.org/project/sphinxfortran-ng)

An improved version of the original sphinx-fortran python module.

This code is based on the following original software:

- [sphinx-fortran](https://gitlab.com/l_sim/sphinx-fortran), on the "l_sim" working branch
- [sphinx-fortran](https://pypi.org/project/sphinx-fortran/), original sphinx-fortran project
- [crackfortran](https://github.com/numpy/numpy/tree/main/numpy/f2py) from the Numpy/f2py python module




## Documentation

The full documentation lives in the `doc` folder:

```console
pip install -r doc/requirements.txt
sphinx-build -b html doc doc/_build/html
```

| Page | Content |
|------|---------|
| `quickstart.rst` | Installation, `conf.py`, first build |
| `how_to_comment.rst` | How to write the Fortran comments (read this first) |
| `fortran_autodoc.rst` | The `f:auto*` directives, options, configuration values |
| `fortran_domain.rst` | Manual directives, field lists, roles, cross-references |
| `examples.rst`, `example_sf_arrays.rst`, `example_ed_input_vars.rst` | Worked examples on `SF_ARRAYS` and `ED_INPUT_VARS` |
| `api.rst` | Python API (`F90toRst`, domain classes) |
| `limitations.rst` | Known limitations and workarounds |

After editing a Fortran file, rebuild with `sphinx-build -E ...`: the sources
are not registered as dependencies of the pages.
