sphinxfortran_ng
  • Quick start
    • Installation
    • Configuring conf.py
    • Commenting the source
    • Using the directives
    • Cross-referencing
    • Rebuilding after a Fortran change
  • Formatting Fortran (.f90) Code for Auto-Documentation
    • General Rules
    • Modules
    • Functions and Subroutines
      • Ways to describe an argument
      • Continuation lines
      • Call relationships
      • Where the description block must be
    • Module Variables
    • Derived Types
    • Interfaces
    • Programs
    • Visibility (public / private)
    • Using reStructuredText in comments
    • Checklist: why is my description missing?
    • Summary
  • Fortran Autodoc
    • Enabling the Extension
      • Configuration values
    • Directives at a glance
    • .. f:automodule::
      • Syntax
      • Options
      • Generated layout
      • Example
    • .. f:automodvars::
    • .. f:autoroutine::
      • Syntax
      • Example
    • .. f:autotype::
    • .. f:autovariable::
    • .. f:autoprogram::
    • .. f:autosrcfile::
      • Options
    • Documentation Comments
    • Automatic contents
    • Cross-Referencing
    • Notes and Limitations
  • Fortran Domain
    • Overview
    • Module and Program Directives
      • .. f:module::
      • .. f:currentmodule::
      • .. f:program::
    • Routine Directives
      • .. f:subroutine::
      • .. f:function::
      • .. f:interface::
      • Options common to all objects
    • Argument and Variable Descriptions
      • Available fields
      • Syntax of the field name
      • Call relationships
      • Documenting a routine, fully
    • Derived Types
      • .. f:type::
    • Variables
      • .. f:variable::
    • Cross-Referencing
      • How a target is looked up
      • Ambiguous references
    • Indices
    • Formatting Guidelines
    • When to Use the Fortran Domain
  • Examples
    • Example 1: a library of functions (SF_ARRAYS)
      • A function with optional arguments: linspace
      • Mathematics and cross-references: upmspace
      • Cross-references to a routine
      • Documenting one routine only
      • Live rendering of SF_ARRAYS
    • Example 2: a module of input variables (ED_INPUT_VARS)
      • A variable with a list of allowed values and a default
      • An array variable
      • Mathematics, and a warning in a variable
      • Logical flags and text following the list
      • Variables with a save attribute
      • Routines of the module
      • Which variables need attention?
      • Live rendering of ED_INPUT_VARS
  • Known limitations
    • Comments
    • Declarations
    • Directives and options
    • Domain
sphinxfortran_ng
  • Search

© Copyright 2026, SciFortran contributors.

Built with Sphinx using a theme provided by Read the Docs.