diff --git a/.gitignore b/.gitignore index 6bff14a84..723a4db8c 100644 --- a/.gitignore +++ b/.gitignore @@ -50,8 +50,7 @@ docs/generated/ docs/generated/**/* docs/**/*.DS_Store docs/**/*.swp - - +!fortran_doc.md !README_figs/* #Docker and Singularity files diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 9c1872b1a..e8700e6e4 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -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 diff --git a/fortran_doc.md b/fortran_doc.md new file mode 100644 index 000000000..906bffbda --- /dev/null +++ b/fortran_doc.md @@ -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 diff --git a/pyproject.toml b/pyproject.toml index 4460d80d3..1961a87d2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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' ] @@ -58,7 +58,8 @@ requires = [ "sphinx-inline-tabs", "sphinxext-rediraffe", "sphinxext-opengraph", - "nbsphinx" + "nbsphinx", + "ford" ] build-backend = "scikit_build_core.build"