Skip to content

Commit 9da0d48

Browse files
authored
docs(rtd): rename migration guides section to special topics (#2564)
so this section can be used for other things if ever needed
1 parent 00eee7a commit 9da0d48

File tree

5 files changed

+14
-14
lines changed

5 files changed

+14
-14
lines changed

.build_rtd_docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,12 +101,12 @@
101101
dst = os.path.join(dstdir, fpth)
102102
shutil.copy(src, dst)
103103

104-
dstdir = "_migration"
104+
dstdir = "_misc"
105105
if os.path.isdir(dstdir):
106106
shutil.rmtree(dstdir)
107107
os.makedirs(dstdir)
108108

109-
print(f"Copy migration guides to {dstdir}")
109+
print(f"Copy special topics to {dstdir}")
110110
fpth = "mf6_6_0_prt_migration_guide.md"
111111
src = os.path.join(fpth)
112112
dst = os.path.join(dstdir, fpth)

.build_rtd_docs/migration.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

.build_rtd_docs/misc.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Special Topics
2+
--------------
3+
4+
This section includes miscellaneous documents, such as version-specific migration guides for particular models or capabilities.
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
:glob:
9+
10+
_misc/mf6_6_0_prt_migration_guide

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ jobs:
171171
modflow6/.build_rtd_docs/index.rst
172172
modflow6/.build_rtd_docs/mf6io.rst
173173
modflow6/.build_rtd_docs/_dev/
174-
modflow6/.build_rtd_docs/_migration/
174+
modflow6/.build_rtd_docs/_misc/
175175
modflow6/.build_rtd_docs/_mf6io/
176176
modflow6/.build_rtd_docs/_mf6run/
177177
modflow6/.build_rtd_docs/_static/

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ CMakeFiles/
113113
.build_rtd_docs/_mf6io
114114
.build_rtd_docs/_mf6src
115115
.build_rtd_docs/_mf6run
116+
.build_rtd_docs/_misc
116117
.build_rtd_docs/_dev
117-
.build_rtd_docs/_migration
118118
latex/
119119
html/
120120
xml/

0 commit comments

Comments
 (0)