diff --git a/LICENSE.rst b/LICENSE.rst index f6c196b2f..944460168 100644 --- a/LICENSE.rst +++ b/LICENSE.rst @@ -1,3 +1,6 @@ +License +======= + :: GNU GENERAL PUBLIC LICENSE diff --git a/Makefile b/Makefile index 0ba0f15f1..0ed28d8a3 100755 --- 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 index d2e5208a9..a6dca52a8 100644 --- 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 index a3fcaf4b6..4404cd2a9 100644 --- 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 deleted file mode 100644 index d76c92b6f..000000000 --- a/doc/source/linked_changelog.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../CHANGES.rst diff --git a/doc/source/linked_changelog.rst b/doc/source/linked_changelog.rst new file mode 120000 index 000000000..71a9d7a55 --- /dev/null +++ b/doc/source/linked_changelog.rst @@ -0,0 +1 @@ +../../CHANGES.rst \ No newline at end of file diff --git a/doc/source/linked_external-dependencies_readme.rst b/doc/source/linked_external-dependencies_readme.rst new file mode 120000 index 000000000..eb002a186 --- /dev/null +++ b/doc/source/linked_external-dependencies_readme.rst @@ -0,0 +1 @@ +../../external-dependencies/README.rst \ No newline at end of file diff --git a/doc/source/linked_external_dependencies_readme.rst b/doc/source/linked_external_dependencies_readme.rst deleted file mode 100644 index a41f5d38b..000000000 --- a/doc/source/linked_external_dependencies_readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../external-dependencies/README.rst diff --git a/doc/source/linked_license.rst b/doc/source/linked_license.rst deleted file mode 100644 index f9c4d5413..000000000 --- a/doc/source/linked_license.rst +++ /dev/null @@ -1,4 +0,0 @@ -License -======= - -.. include:: ../../LICENSE.rst diff --git a/doc/source/linked_license.rst b/doc/source/linked_license.rst new file mode 120000 index 000000000..efcea71f6 --- /dev/null +++ b/doc/source/linked_license.rst @@ -0,0 +1 @@ +../../LICENSE.rst \ No newline at end of file diff --git a/doc/source/linked_main_readme.rst b/doc/source/linked_main_readme.rst deleted file mode 100644 index a6210d3d8..000000000 --- a/doc/source/linked_main_readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst diff --git a/doc/source/linked_main_readme.rst b/doc/source/linked_main_readme.rst new file mode 120000 index 000000000..c768ff7d9 --- /dev/null +++ b/doc/source/linked_main_readme.rst @@ -0,0 +1 @@ +../../README.rst \ No newline at end of file diff --git a/scripts/generate-reference-docs.py b/scripts/generate-reference-docs.py new file mode 100644 index 000000000..ccd1aded9 --- /dev/null +++ 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()