Skip to content
This repository was archived by the owner on Aug 28, 2024. It is now read-only.

Commit

Permalink
Added FORD documentation parser
Browse files Browse the repository at this point in the history
  • Loading branch information
daminton committed Dec 19, 2023
1 parent 9cf29b2 commit fcf23e3
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 10 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,7 @@ docs/generated/
docs/generated/**/*
docs/**/*.DS_Store
docs/**/*.swp


!fortran_doc.md
!README_figs/*

#Docker and Singularity files
Expand Down
8 changes: 2 additions & 6 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,8 @@ build:
os: ubuntu-22.04
tools:
python: "3.11"

# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub

pre_build:
- ford fortran_doc.md -o ../_readthedocs/html/fortran/
python:
install:
- requirements: docs/requirements.txt
27 changes: 27 additions & 0 deletions fortran_doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
project: Swiftest
author: David A. Minton
summary: High performance Fortran functions used by the swiftest project via ISO_C_BINDING interfaces and Cython.
favicon: ./docs/_static/logos/swiftest_logo.svg
project_github: https://github.com/profminton/swiftest
project_download: https://github.com/profminton/swiftest/releases
project_website: https://swiftest.readthedocs.io
author: David A. Minton
github: https://github.com/profminton/
src_dir: src
output_dir: ./docs/_build/html/fortran
media_dir: ./docs/_static
source: true
graph: true
sort: alpha
print_creation_date: true
extra_mods: iso_c_binding:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fC_005fBINDING.html
ieee_arithmetic:https://gcc.gnu.org/onlinedocs/gfortran/IEEE-modules.html
ieee_exceptions:https://gcc.gnu.org/onlinedocs/gfortran/IEEE-modules.html
iso_fortran_env:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fFORTRAN_005fENV.html
creation_date: %Y-%m-%d %H:%M %z
md_extensions: markdown.extensions.toc
markdown.extensions.smarty
---

This is the documentation for the Fortran components of Swiftest
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ dependencies = [
'matplotlib>=3.7',
'astropy>=5.2',
'astroquery>=0.4.6',
'tqdm>=4.66',
'tqdm>=4.64.1',
'cython>=3.0.0'
]

Expand All @@ -58,7 +58,8 @@ requires = [
"sphinx-inline-tabs",
"sphinxext-rediraffe",
"sphinxext-opengraph",
"nbsphinx"
"nbsphinx",
"ford"
]
build-backend = "scikit_build_core.build"

Expand Down

0 comments on commit fcf23e3

Please sign in to comment.