Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(rtd): include DFN specification in dev docs #1948

Merged
merged 5 commits into from
Nov 12, 2024
Merged

docs(rtd): include DFN specification in dev docs #1948

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fdfdd9d
docs(rtd): include DFN specification in dev docs
wpbonelli Jul 15, 2024
b3f3dc1
update .gitignore, cleanup dfn spec doc, build deprecations table in …
wpbonelli Jul 16, 2024
7061cf7
revise dfn readme
wpbonelli Nov 12, 2024
371e5d3
fix
wpbonelli Nov 12, 2024
a4f7554
fixes
wpbonelli Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions .build_rtd_docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
Expand All @@ -81,6 +81,12 @@
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")
shutil.copy(src, dst)

# -- build the deprecations table --------------------------------------------
print("Build the deprecations markdown table")
pth = os.path.join("..", "doc", "mf6io", "mf6ivar")
Expand Down
5 changes: 3 additions & 2 deletions .build_rtd_docs/dev.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ CMakeFiles/
.build_rtd_docs/_mf6io
.build_rtd_docs/_mf6src
.build_rtd_docs/_mf6run
.build_rtd_docs/_dev
latex/
html/
xml/
Expand Down
Loading
Loading