https://github.com/vacumm/sphinx-fortran

Fortran domain and autodoc extensions to Sphinx

Science Score: 10.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
○
codemeta.json file
○
.zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
3 of 17 committers (17.6%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (9.7%) to scientific vocabulary

Keywords

documentation fortran numpy sphinx-doc sphinx-extension

Last synced: 6 months ago · JSON representation

Repository

Fortran domain and autodoc extensions to Sphinx

Basic Info

Host: GitHub
Owner: VACUMM
License: other
Language: Python
Default Branch: master
Homepage:
Size: 193 KB

Statistics

Stars: 45
Watchers: 16
Forks: 30
Open Issues: 28
Releases: 0

Topics

documentation fortran numpy sphinx-doc sphinx-extension

Created over 10 years ago · Last pushed 11 months ago

Metadata Files

Readme License

README.rst

Sphinx-Fortran extensions
=========================

.. image:: https://badge.fury.io/py/sphinx-fortran.svg
    :target: https://badge.fury.io/py/sphinx-fortran

.. image:: https://travis-ci.org/VACUMM/sphinx-fortran.svg?branch=master
    :target: https://travis-ci.org/VACUMM/sphinx-fortran

.. image:: https://readthedocs.org/projects/sphinx-fortran/badge/?version=latest
    :target: http://sphinx-fortran.readthedocs.org/en/latest/?badge=latest


Purpose
-------

This package provides two Sphinx (http://sphinx.pocoo.org/) extensions
to the Fortran (90) language:

- ``sphinxfortran.fortran_domain``: Sphinx domain for fortran.
- ``sphinxfortran.fortran_autodoc``: Auto-documenting fortran code.


License
-------

This package has the same license as VACUMM (http://www.ifremer.fr/vacumm)
from which it originates: CeciLL-A
(http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.html),
which is compatible with the GPL.


Prerequisites
-------------

The ``sphinx`` and ``numpy`` packages.


Installation
------------

With ``pip``::

    pip install sphinx-fortran


With ``conda``::

    conda install -c vacumm -c conda-forge sphinx-fortran

From sources::

    git clone https://github.com/VACUMM/sphinx-fortran.git
    cd sphinx-fortran
    python setup.py install


Quick start
-----------

1. Add this extension to your sphinx ``conf.py``.
2. List you fortran source files in the variable
   ``fortran_src`` of your ``conf.py``.
3. Generate their documentation in rst files using
   directives like::

       .. f:automodule:: mymodule


Bugs and requests
-----------------

Please go to this GitHub page:
https://github.com/VACUMM/sphinx-fortran/issues


Authors
-------

Stephane Raynaud (stephane.raynaud(at)gmail.com)

Thanks: Thomas Gastine and other pull request contributors.


Documentation
-------------

Website: http://sphinx-fortran.readthedocs.org

Owner

Name: VACUMM
Login: VACUMM
Kind: organization

Website: http://www.ifremer.fr/vacumm
Repositories: 7
Profile: https://github.com/VACUMM

A python library for ocean sciences by Actimar/IFREMER

GitHub Events

Total

Issue comment event: 1
Push event: 1
Pull request event: 3
Fork event: 2

Last Year

Issue comment event: 1
Push event: 1
Pull request event: 3
Fork event: 2

Committers

Last synced: about 2 years ago

All Time

Total Commits: 68
Total Committers: 17
Avg Commits per committer: 4.0
Development Distribution Score (DDS): 0.485

Past Year

Commits: 3
Committers: 3
Avg Commits per committer: 1.0
Development Distribution Score (DDS): 0.667

Top Committers

Name	Email	Commits
Stephane Raynaud	s**d@g**m	35
Stephane Raynaud	s**d@s**r	9
Jonathan	w**s@a**r	5
Damien Caliste	d**e@f**r	4
gastineau	g**u@i**r	2
sradanov	s**s@m**r	2
Axel Kohlmeyer	a**y@g**m	1
Jared Dillard	j**b@g**m	1
Loïc Reynier	8**r@u**m	1
Carlos Frederico Bastarz	c**z@g**m	1
Ian Bell	i**l@n**v	1
Hugh Sorby	h**y@a**z	1
RogierFloors	R**s@u**m	1
Rich Townsend	t**d@a**u	1
Dusan Vuckovic	d**n@d**m	1
Warrick Ball	w**l@b**k	1
Jonathan Hogg	j**1@g**m	1

Committer Domains (Top 20 + Academic)

bison.ph.bham.ac.uk: 1 dvuckovic.com: 1 astro.wisc.edu: 1 auckland.ac.nz: 1 nist.gov: 1 meteo.fr: 1 imcce.fr: 1 free.fr: 1 apf2014006.actimar.fr: 1 shom.fr: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 32
Total pull requests: 22
Average time to close issues: 7 months
Average time to close pull requests: 4 months
Total issue authors: 22
Total pull request authors: 16
Average comments per issue: 1.5
Average comments per pull request: 0.36
Merged pull requests: 20
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 2
Average time to close issues: N/A
Average time to close pull requests: 4 months
Issue authors: 0
Pull request authors: 2
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

ndarmage (5)
ostueker (2)
diegojco (2)
jdillard (2)
sradanov (2)
micromad (2)
jhaiduce (2)
kousuke-nakano (1)
rhdtownsend (1)
Cirdans-Home (1)
zengtianli (1)
gastineau (1)
dvuckovic (1)
XonqNopp (1)
Beliavsky (1)

Pull Request Authors

dcaliste (4)
akohlmey (3)
sradanov (2)
gastineau (2)
clatim (2)
rhdtownsend (1)
ianhbell (1)
jdillard (1)
cfbastarz (1)
dvuckovic (1)
warrickball (1)
RogierFloors (1)
hsorby (1)
jowilk (1)
loicreynier (1)

Top Labels

Issue Labels

enhancement (1) help wanted (1)

Pull Request Labels

Packages

Total packages: 2
Total downloads:
- pypi 1,672 last-month

Total dependent packages: 5
(may contain duplicates)
Total dependent repositories: 79
(may contain duplicates)
Total versions: 4
Total maintainers: 1

pypi.org: sphinx-fortran

Fortran domain and autodoc extensions to Sphinx

Homepage: http://sphinx-fortran.readthedocs.org
Documentation: https://sphinx-fortran.readthedocs.io/
License: CeCiLL-A
Latest release: 1.1.1
published over 6 years ago

Versions: 3
Dependent Packages: 5
Dependent Repositories: 79
Downloads: 1,672 Last month

Rankings

Dependent packages count: 1.6%

Dependent repos count: 1.7%

Average: 4.0%

Downloads: 8.9%

Maintainers (1)

stefraynaud

Last synced: 6 months ago

conda-forge.org: sphinx-fortran

Homepage: http://sphinx-fortran.readthedocs.org
License: CECILL-2.1
Latest release: 1.1.1
published over 3 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Forks count: 29.4%

Dependent repos count: 34.0%

Average: 38.4%

Stargazers count: 39.1%

Dependent packages count: 51.2%

Last synced: 6 months ago

Dependencies

requirements.txt pypi

future *
numpy >=1.0
six *
sphinx >=1.0