docs(rtd): include DFN specification in dev docs

wpbonelli · Jul 15, 2024 · 9873f00 · 9873f00
1 parent 47762d4
commit 9873f00
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git 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
@@ -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