diff --git a/docs/api/licenses/dependency-notices.rst b/docs/api/copyright/dependency-notices.rst similarity index 100% rename from docs/api/licenses/dependency-notices.rst rename to docs/api/copyright/dependency-notices.rst diff --git a/docs/api/licenses/index.rst b/docs/api/copyright/index.rst similarity index 100% rename from docs/api/licenses/index.rst rename to docs/api/copyright/index.rst diff --git a/docs/api/licenses/libloot-notices.rst b/docs/api/copyright/libloot-notices.rst similarity index 100% rename from docs/api/licenses/libloot-notices.rst rename to docs/api/copyright/libloot-notices.rst diff --git a/docs/api/licenses/Apache-2.0 b/docs/api/copyright/licenses/Apache-2.0 similarity index 100% rename from docs/api/licenses/Apache-2.0 rename to docs/api/copyright/licenses/Apache-2.0 diff --git a/docs/api/licenses/BSD-3-Clause b/docs/api/copyright/licenses/BSD-3-Clause similarity index 100% rename from docs/api/licenses/BSD-3-Clause rename to docs/api/copyright/licenses/BSD-3-Clause diff --git a/docs/api/licenses/GFDL-1.3-no-invariants-or-later b/docs/api/copyright/licenses/GFDL-1.3-no-invariants-or-later similarity index 100% rename from docs/api/licenses/GFDL-1.3-no-invariants-or-later rename to docs/api/copyright/licenses/GFDL-1.3-no-invariants-or-later diff --git a/docs/api/licenses/GPL-3.0-or-later b/docs/api/copyright/licenses/GPL-3.0-or-later similarity index 100% rename from docs/api/licenses/GPL-3.0-or-later rename to docs/api/copyright/licenses/GPL-3.0-or-later diff --git a/docs/api/licenses/MIT b/docs/api/copyright/licenses/MIT similarity index 100% rename from docs/api/licenses/MIT rename to docs/api/copyright/licenses/MIT diff --git a/docs/api/licenses/Unicode-3.0 b/docs/api/copyright/licenses/Unicode-3.0 similarity index 100% rename from docs/api/licenses/Unicode-3.0 rename to docs/api/copyright/licenses/Unicode-3.0 diff --git a/docs/api/licenses/texts.rst b/docs/api/copyright/texts.rst similarity index 67% rename from docs/api/licenses/texts.rst rename to docs/api/copyright/texts.rst index 5c1943c9..993556d2 100644 --- a/docs/api/licenses/texts.rst +++ b/docs/api/copyright/texts.rst @@ -7,35 +7,35 @@ Copyright License Texts GNU General Public License 3.0 ------------------------------ -.. include:: GPL-3.0-or-later +.. include:: licenses/GPL-3.0-or-later :literal: GNU Free Documentation License 1.3 ---------------------------------- -.. include:: GFDL-1.3-no-invariants-or-later +.. include:: licenses/GFDL-1.3-no-invariants-or-later :literal: Apache License 2.0 ------------------ -.. include:: Apache-2.0 +.. include:: licenses/Apache-2.0 :literal: BSD 3-Clause "New" or "Revised" License --------------------------------------- -.. include:: Apache-2.0 +.. include:: licenses/BSD-3-Clause :literal: MIT License ----------- -.. include:: MIT +.. include:: licenses/MIT :literal: Unicode License v3 ------------------ -.. include:: Unicode-3.0 +.. include:: licenses/Unicode-3.0 :literal: diff --git a/docs/index.rst b/docs/index.rst index a7829316..51e947ef 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,7 @@ libloot api/sorting api/rust_api_reference api/cpp_api_reference - api/licenses/index + api/copyright/index api/changelog .. toctree:: diff --git a/docs/scripts/licenses.py b/docs/scripts/licenses.py index 35c247d4..5590bbfa 100644 --- a/docs/scripts/licenses.py +++ b/docs/scripts/licenses.py @@ -13,7 +13,7 @@ import shutil import subprocess import tomllib -def process_licenses(attribution_dir, destination_dir): +def process_licenses(source_dir, destination_dir): # CC0, Unlicense and Zlib don't need licenses to be included. # MPL doesn't need the license included with binary distributions, and # allows distribution under a compatible license. @@ -30,7 +30,7 @@ def process_licenses(attribution_dir, destination_dir): 'Zlib' ] - for entry in os.scandir(os.path.join(attribution_dir, 'licenses')): + for entry in os.scandir(source_dir): if entry.name not in skip_entries: destination_path = os.path.join(destination_dir, entry.name) if entry.is_dir(): @@ -78,9 +78,9 @@ def get_target_dependency_names(target_package_name): if __name__ == "__main__": target_package_name = 'libloot-cpp' - cargo_toml_path = '../cpp/Cargo.toml' - attribution_dir = 'build/attribution' - output_dir = 'api/licenses' + cargo_toml_path = os.path.join('..', 'cpp', 'Cargo.toml') + attribution_dir = os.path.join('build', 'attribution') + output_dir = os.path.join('api', 'copyright') subprocess.run( [ @@ -97,7 +97,7 @@ if __name__ == "__main__": check=True ) - process_licenses(attribution_dir, output_dir) + process_licenses(os.path.join(attribution_dir, 'licenses'), os.path.join(output_dir, 'licenses')) target_dependency_names = get_target_dependency_names(target_package_name)