From 9873f00efdb1203079afa60b4c3468d91ea71fd6 Mon Sep 17 00:00:00 2001 From: wpbonelli Date: Sun, 14 Jul 2024 21:53:54 -0400 Subject: [PATCH] docs(rtd): include DFN specification in dev docs --- .build_rtd_docs/conf.py | 9 +++++++-- .build_rtd_docs/dev.rst | 5 +++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/.build_rtd_docs/conf.py b/.build_rtd_docs/conf.py index 2de05fbe9be..638e33fc080 100644 --- a/.build_rtd_docs/conf.py +++ b/.build_rtd_docs/conf.py @@ -60,7 +60,7 @@ dstdir = "_dev" fpth = "DEVELOPER.md" src = os.path.join("..", fpth) -dst = os.path.join(dstdir, fpth) +dst = os.path.join(dstdir, fpth.lower()) # clean up an existing _mf6run directory if os.path.isdir(dstdir): shutil.rmtree(dstdir) @@ -72,7 +72,7 @@ # -- copy contributor docs fpth = "CONTRIBUTING.md" src = os.path.join("..", fpth) -dst = os.path.join(dstdir, fpth) +dst = os.path.join(dstdir, fpth.lower()) shutil.copy(src, dst) # -- copy style guide @@ -81,6 +81,11 @@ dst = os.path.join(dstdir, fpth) shutil.copy(src, dst) +# -- copy DFN spec +fpth = "readme.md" +src = os.path.join("..", "doc", "mf6io", "mf6ivar", fpth) +dst = os.path.join(dstdir, "dfn.md") + # -- copy deprecations markdown --------------------------------------------- print("Copy the deprecations table") dstdir = "_mf6run" diff --git a/.build_rtd_docs/dev.rst b/.build_rtd_docs/dev.rst index e90276ecb80..c9dc57173ed 100644 --- a/.build_rtd_docs/dev.rst +++ b/.build_rtd_docs/dev.rst @@ -7,6 +7,7 @@ This section includes developer instructions and conventions. :maxdepth: 1 :glob: - _dev/CONTRIBUTING.md - _dev/DEVELOPER.md + _dev/contributing.md + _dev/developer.md _dev/styleguide.md + _dev/dfn.md