Started doc/symlink generation script. Using symlinks instead of incl…

…udes
nens · Jul 4, 2019 · 1ae9989 · 1ae9989
1 parent 6eb77c0
commit 1ae9989
Show file tree

Hide file tree

Showing 10 changed files with 36 additions and 9 deletions.
diff --git a/LICENSE.rst b/LICENSE.rst
@@ -1,3 +1,6 @@
+License
+=======
+
 ::
 
 		      GNU GENERAL PUBLIC LICENSE

diff --git a/Makefile b/Makefile
@@ -140,6 +140,7 @@ html:
 	@echo "------------------------------------"
 	@echo "Building documentation using sphinx."
 	@echo "------------------------------------"
+	python3 scripts/generate-reference-docs.py
 	cd doc; make html
 	@echo "Open doc/build/html/index.html to see the documentation"
 

diff --git a/__init__.py b/__init__.py
@@ -4,7 +4,7 @@
 actually load the plugin.
 
 Note: beforehand we call our dependency mechanism (see
-:doc:`linked_external_dependencies_readme`) to ensure all dependencies are
+:doc:`linked_external-dependencies_readme`) to ensure all dependencies are
 there.
 
 """

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -10,7 +10,7 @@ ThreeDiToolbox developer information
    :maxdepth: 2
    :caption: Project setup
 
-   linked_external_dependencies_readme
+   linked_external-dependencies_readme
    documentation
 
 

diff --git a/doc/source/linked_changelog.rst b/doc/source/linked_changelog.rst
diff --git a/doc/source/linked_changelog.rst b/doc/source/linked_changelog.rst
@@ -0,0 +1 @@
+../../CHANGES.rst
diff --git a/doc/source/linked_external-dependencies_readme.rst b/doc/source/linked_external-dependencies_readme.rst
@@ -0,0 +1 @@
+../../external-dependencies/README.rst
diff --git a/doc/source/linked_external_dependencies_readme.rst b/doc/source/linked_external_dependencies_readme.rst
diff --git a/doc/source/linked_license.rst b/doc/source/linked_license.rst
diff --git a/doc/source/linked_license.rst b/doc/source/linked_license.rst
@@ -0,0 +1 @@
+../../LICENSE.rst
diff --git a/doc/source/linked_main_readme.rst b/doc/source/linked_main_readme.rst
diff --git a/doc/source/linked_main_readme.rst b/doc/source/linked_main_readme.rst
@@ -0,0 +1 @@
+../../README.rst
diff --git a/scripts/generate-reference-docs.py b/scripts/generate-reference-docs.py
@@ -0,0 +1,26 @@
+from ThreeDiToolbox import PLUGIN_DIR
+
+
+DOC_SOURCE_DIR = PLUGIN_DIR / "doc" / "source"
+
+
+
+def generate_subdir_readme_symlinks():
+    """Create a symlink for every README in a direct subdirectory."""
+    for readme in PLUGIN_DIR.glob('*/README.rst'):
+        subdir_name = readme.parent.name
+        target_name = f"linked_{subdir_name}_readme.rst"
+        target = DOC_SOURCE_DIR / target_name
+        # Relative: an absolute symlink (in the docker) doesn't work locally.
+        relative_symlink = f"../../{subdir_name}/README.rst"
+        if not target.exists():
+            target.symlink_to(relative_symlink)
+            print(f"Added symlink {target_name} to {relative_symlink}")
+
+
+def main():
+    generate_subdir_readme_symlinks()
+
+
+if __name__ == "__main__":
+    main()
-Original file line number
+Diff line change
@@ -1,3 +1,6 @@
+    License
+    =======
     ::
     		      GNU GENERAL PUBLIC LICENSE
@@ Expand Down @@