Reworks repository layout for automatic doc generation

rwdougla · Feb 6, 2022 · b3c532e · b3c532e
1 parent 12eaf0d
commit b3c532e
Show file tree

Hide file tree

Showing 25 changed files with 32 additions and 12 deletions.
diff --git a/Readme.md b/Readme.md
@@ -8,24 +8,43 @@
 # SG20: Teaching Topics
 
 ## Modules:
+* [Compile-time programming](#compile-time-programming)
+* [Meta-error handling](#meta-error-handling)
 * [C++ object model](#c-object-model)
+* [Program design](#program-design)
 * [User-defined types](#user-defined-types)
 * [Functions](#functions)
 
+### Compile-time programming
+* [requires-clause](sources/modules/compile-time-programming/requires-clause.md)
+* [concepts](sources/modules/compile-time-programming/concepts.md)
+* [requires-expressions](sources/modules/compile-time-programming/requires-expressions.md)
+* [function-templates](sources/modules/compile-time-programming/function-templates.md)
+
+### Meta-error handling
+* [static_assert](sources/modules/meta-error-handling/static_assert.md)
+
 ### C++ object model
-* [rule-of-five](object-model/rule-of-five.md)
-* [constant-objects](object-model/constant-objects.md)
-* [special-member-functions](object-model/special-member-functions.md)
-* [declarations](object-model/declarations.md)
-* [objects](object-model/objects.md)
-* [types](object-model/types.md)
-* [copy-semantics](object-model/copy-semantics.md)
-* [rule-of-zero](object-model/rule-of-zero.md)
-* [move-semantics](object-model/move-semantics.md)
+* [rule-of-five](sources/modules/object-model/rule-of-five.md)
+* [constant-objects](sources/modules/object-model/constant-objects.md)
+* [special-member-functions](sources/modules/object-model/special-member-functions.md)
+* [declarations](sources/modules/object-model/declarations.md)
+* [objects](sources/modules/object-model/objects.md)
+* [constructors](sources/modules/object-model/constructors.md)
+* [types](sources/modules/object-model/types.md)
+* [copy-semantics](sources/modules/object-model/copy-semantics.md)
+* [rule-of-zero](sources/modules/object-model/rule-of-zero.md)
+* [move-semantics](sources/modules/object-model/move-semantics.md)
+
+### Program design
+* [concepts](compile-time-programmings/concepts.md)
 
 ### User-defined types
 * [user-defined-literals](functions/user-defined-literals.md)
 
 ### Functions
-* [user-defined-literals](functions/user-defined-literals.md)
+* [defaulted-parameters](sources/modules/functions/defaulted-parameters.md)
+* [calling-functions](sources/modules/functions/calling-functions.md)
+* [user-defined-literals](sources/modules/functions/user-defined-literals.md)
+* [member-functions](sources/modules/functions/member-functions.md)
 
diff --git a/compile-time-programming/concepts.md → ...ules/compile-time-programming/concepts.md b/compile-time-programming/concepts.md → ...ules/compile-time-programming/concepts.md
diff --git a/...le-time-programming/function-templates.md → ...le-time-programming/function-templates.md b/...le-time-programming/function-templates.md → ...le-time-programming/function-templates.md
diff --git a/compile-time-programming/requires-clause.md → ...mpile-time-programming/requires-clause.md b/compile-time-programming/requires-clause.md → ...mpile-time-programming/requires-clause.md
diff --git a/...-time-programming/requires-expressions.md → ...-time-programming/requires-expressions.md b/...-time-programming/requires-expressions.md → ...-time-programming/requires-expressions.md
diff --git a/functions/calling-functions.md → ...es/modules/functions/calling-functions.md b/functions/calling-functions.md → ...es/modules/functions/calling-functions.md
diff --git a/functions/defaulted-parameters.md → ...modules/functions/defaulted-parameters.md b/functions/defaulted-parameters.md → ...modules/functions/defaulted-parameters.md
diff --git a/functions/member-functions.md → ...ces/modules/functions/member-functions.md b/functions/member-functions.md → ...ces/modules/functions/member-functions.md
diff --git a/functions/user-defined-literals.md → ...odules/functions/user-defined-literals.md b/functions/user-defined-literals.md → ...odules/functions/user-defined-literals.md
diff --git a/meta-error-handling/static_assert.md → ...ules/meta-error-handling/static_assert.md b/meta-error-handling/static_assert.md → ...ules/meta-error-handling/static_assert.md
diff --git a/object-model/constant-objects.md → .../modules/object-model/constant-objects.md b/object-model/constant-objects.md → .../modules/object-model/constant-objects.md
diff --git a/object-model/constructors.md → sources/modules/object-model/constructors.md b/object-model/constructors.md → sources/modules/object-model/constructors.md
diff --git a/object-model/copy-semantics.md → ...es/modules/object-model/copy-semantics.md b/object-model/copy-semantics.md → ...es/modules/object-model/copy-semantics.md
diff --git a/object-model/declarations.md → sources/modules/object-model/declarations.md b/object-model/declarations.md → sources/modules/object-model/declarations.md
diff --git a/object-model/move-semantics.md → ...es/modules/object-model/move-semantics.md b/object-model/move-semantics.md → ...es/modules/object-model/move-semantics.md
diff --git a/object-model/objects.md → sources/modules/object-model/objects.md b/object-model/objects.md → sources/modules/object-model/objects.md
diff --git a/object-model/rule-of-five.md → sources/modules/object-model/rule-of-five.md b/object-model/rule-of-five.md → sources/modules/object-model/rule-of-five.md
diff --git a/object-model/rule-of-zero.md → sources/modules/object-model/rule-of-zero.md b/object-model/rule-of-zero.md → sources/modules/object-model/rule-of-zero.md
diff --git a/object-model/special-member-functions.md → .../object-model/special-member-functions.md b/object-model/special-member-functions.md → .../object-model/special-member-functions.md
diff --git a/object-model/types.md → sources/modules/object-model/types.md b/object-model/types.md → sources/modules/object-model/types.md
diff --git a/program-design/concepts.md → sources/modules/program-design/concepts.md b/program-design/concepts.md → sources/modules/program-design/concepts.md
diff --git a/user-defined-types/user-defined-literals.md → ...er-defined-types/user-defined-literals.md b/user-defined-types/user-defined-literals.md → ...er-defined-types/user-defined-literals.md
diff --git a/gen_readme.py → tools/mgmt_tools/gen_readme.py b/gen_readme.py → tools/mgmt_tools/gen_readme.py
@@ -190,7 +190,7 @@ def readme_generator_driver() -> None:
     Run the Readme.md generation process.
     """
     readme_filename = "Readme.md"
-    repo_root = Path('.')
+    repo_root = Path('sources/modules/')
     teaching_modules: List[TeachingModule] = []
 
     for directory in filter(

diff --git a/topic_updater.py → tools/mgmt_tools/topic_updater.py b/topic_updater.py → tools/mgmt_tools/topic_updater.py
@@ -388,7 +388,7 @@ def exclude_non_topic_files(path: Path) -> bool:
 
         topic_paths = list(
             filter(exclude_non_topic_files,
-                   Path(".").glob("**/*.md")))
+                   Path("sources/modules/").glob("**/*.md")))
     else:
         topic_paths = args.topic_paths
 

diff --git a/tools/requirements.txt b/tools/requirements.txt
@@ -1,2 +1,3 @@
 pytest
 pytest-pythonpath
+mock