chore(docs): restructuring of API documentation (#1711)

Back end update to clean up documentation website Signed-off-by: Chris Butler <[email protected]>
oscal-compass · Oct 31, 2024 · 17e9ae3 · 17e9ae3
1 parent 80d9a9f
commit 17e9ae3
Show file tree

Hide file tree

Showing 323 changed files with 1,111 additions and 522 deletions.
diff --git a/.github/workflows/python-push.yml b/.github/workflows/python-push.yml
@@ -90,6 +90,10 @@ jobs:
       continue-on-error: true 
       run: |
         make code-typing
+    - name: Install documenation dependencies
+      if: steps.core-version.outputs.core == 'true'
+      run: |
+        make docs-ubuntu-deps
     - name: Validate website content (mkdocs)
       if: steps.core-version.outputs.core == 'true'
       run: |
@@ -176,6 +180,9 @@ jobs:
     - name: Install build tools
       run: |
         make develop
+    - name: Install documenation dependencies
+      run: |
+        make docs-ubuntu-deps
     - name: Create release
       shell: bash
       run: |

diff --git a/.github/workflows/python-test.yml b/.github/workflows/python-test.yml
@@ -62,6 +62,9 @@ jobs:
       continue-on-error: true
       run: |
         make code-typing
+    - name: Install documenation dependencies
+      run: |
+        make docs-ubuntu-deps
     - name: Validate website content (mkdocs)
       run: |
         make docs-validate

diff --git a/.gitignore b/.gitignore
@@ -51,3 +51,5 @@ tmp_bin_test
 
 /venv.trestle/
 
+# mkdocs
+.cache/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -73,7 +73,7 @@ repos:
     rev: 0.7.17
     hooks:
     - id: mdformat
-      exclude: "CHANGELOG.md|docs/mkdocs_code_of_conduct.md|docs/maintainers.md|docs/api_reference|tests/data/author|docs/contributing/mkdocs_contributing.md|tests/data/jinja_markdown_include|tests/data/jinja_cmd/number_captions_data.md|tests/data/jinja_cmd/number_captions_expected_output.md"
+      exclude: "CHANGELOG.md|docs/contributing/maintainers.md|docs/reference/API|tests/data/author|docs/contributing/index.md|tests/data/jinja_markdown_include|tests/data/jinja_cmd/number_captions_data.md|tests/data/jinja_cmd/number_captions_expected_output.md"
       additional_dependencies:
       - mdformat-tables
       - mdformat-config

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -114,7 +114,7 @@ e.g.
 
 We have tried to make it as easy as possible to make contributions. This
 applies to how we handle the legal aspects of contribution. We use the
-same approach - the [Developer's Certificate of Origin 1.1 (DCO)](https://oscal-compass.github.io/compliance-trestle/contributing/DCO/) - that the Linux® Kernel [community](https://elinux.org/Developer_Certificate_Of_Origin)
+same approach - the [Developer's Certificate of Origin 1.1 (DCO)](https://oscal-compass.github.io/compliance-trestle/contributing/DCO/) - that the Linux® Kernel [community](https://developercertificate.org/)
 uses to manage code contributions.
 
 We simply ask that when submitting a patch for review, the developer

diff --git a/Makefile b/Makefile
@@ -82,11 +82,17 @@ release::
 gen-oscal::
 	python ./scripts/gen_oscal.py
 
+docs-osx-deps:
+	brew install cairo freetype libffi libjpeg libpng zlib
+
+docs-ubuntu-deps:
+	sudo apt-get -y install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
+
 docs-automation::
 	python ./scripts/website_automation.py
 
 docs-validate:: docs-automation
-	mkdocs build -v -c -s
+	mkdocs build -c -s
 	rm -rf site
 
 docs-serve: docs-automation

diff --git a/docs/api_reference/trestle.cli.md b/docs/api_reference/trestle.cli.md
diff --git a/docs/api_reference/trestle.common.common_types.md b/docs/api_reference/trestle.common.common_types.md
diff --git a/docs/api_reference/trestle.common.const.md b/docs/api_reference/trestle.common.const.md
diff --git a/docs/api_reference/trestle.common.err.md b/docs/api_reference/trestle.common.err.md
diff --git a/docs/api_reference/trestle.common.file_utils.md b/docs/api_reference/trestle.common.file_utils.md
diff --git a/docs/api_reference/trestle.common.list_utils.md b/docs/api_reference/trestle.common.list_utils.md
diff --git a/docs/api_reference/trestle.common.load_validate.md b/docs/api_reference/trestle.common.load_validate.md
diff --git a/docs/api_reference/trestle.common.log.md b/docs/api_reference/trestle.common.log.md
diff --git a/docs/api_reference/trestle.common.model_utils.md b/docs/api_reference/trestle.common.model_utils.md
diff --git a/docs/api_reference/trestle.common.str_utils.md b/docs/api_reference/trestle.common.str_utils.md
diff --git a/docs/api_reference/trestle.common.trash.md b/docs/api_reference/trestle.common.trash.md
diff --git a/docs/api_reference/trestle.common.type_utils.md b/docs/api_reference/trestle.common.type_utils.md
diff --git a/docs/api_reference/trestle.core.all_validator.md b/docs/api_reference/trestle.core.all_validator.md
diff --git a/docs/api_reference/trestle.core.base_model.md b/docs/api_reference/trestle.core.base_model.md
diff --git a/docs/api_reference/trestle.core.catalog.catalog_api.md b/docs/api_reference/trestle.core.catalog.catalog_api.md
diff --git a/docs/api_reference/trestle.core.catalog.catalog_interface.md b/docs/api_reference/trestle.core.catalog.catalog_interface.md
diff --git a/docs/api_reference/trestle.core.catalog.catalog_merger.md b/docs/api_reference/trestle.core.catalog.catalog_merger.md
diff --git a/docs/api_reference/trestle.core.catalog.catalog_reader.md b/docs/api_reference/trestle.core.catalog.catalog_reader.md
diff --git a/docs/api_reference/trestle.core.catalog.catalog_writer.md b/docs/api_reference/trestle.core.catalog.catalog_writer.md
diff --git a/docs/api_reference/trestle.core.catalog_validator.md b/docs/api_reference/trestle.core.catalog_validator.md
diff --git a/docs/api_reference/trestle.core.commands.add.md b/docs/api_reference/trestle.core.commands.add.md
diff --git a/docs/api_reference/trestle.core.commands.assemble.md b/docs/api_reference/trestle.core.commands.assemble.md
diff --git a/docs/api_reference/trestle.core.commands.author.catalog.md b/docs/api_reference/trestle.core.commands.author.catalog.md
diff --git a/docs/api_reference/trestle.core.commands.author.command.md b/docs/api_reference/trestle.core.commands.author.command.md
diff --git a/docs/api_reference/trestle.core.commands.author.common.md b/docs/api_reference/trestle.core.commands.author.common.md
diff --git a/docs/api_reference/trestle.core.commands.author.component.md b/docs/api_reference/trestle.core.commands.author.component.md
diff --git a/docs/api_reference/trestle.core.commands.author.consts.md b/docs/api_reference/trestle.core.commands.author.consts.md
diff --git a/docs/api_reference/trestle.core.commands.author.docs.md b/docs/api_reference/trestle.core.commands.author.docs.md
diff --git a/docs/api_reference/trestle.core.commands.author.folders.md b/docs/api_reference/trestle.core.commands.author.folders.md
diff --git a/docs/api_reference/trestle.core.commands.author.headers.md b/docs/api_reference/trestle.core.commands.author.headers.md
diff --git a/docs/api_reference/trestle.core.commands.author.jinja.md b/docs/api_reference/trestle.core.commands.author.jinja.md
diff --git a/docs/api_reference/trestle.core.commands.author.prof.md b/docs/api_reference/trestle.core.commands.author.prof.md
diff --git a/docs/api_reference/trestle.core.commands.author.ssp.md b/docs/api_reference/trestle.core.commands.author.ssp.md
diff --git a/docs/api_reference/trestle.core.commands.author.versioning.template_versioning.md b/docs/api_reference/trestle.core.commands.author.versioning.template_versioning.md
diff --git a/docs/api_reference/trestle.core.commands.command_docs.md b/docs/api_reference/trestle.core.commands.command_docs.md
diff --git a/docs/api_reference/trestle.core.commands.common.cmd_utils.md b/docs/api_reference/trestle.core.commands.common.cmd_utils.md
diff --git a/docs/api_reference/trestle.core.commands.common.return_codes.md b/docs/api_reference/trestle.core.commands.common.return_codes.md
diff --git a/docs/api_reference/trestle.core.commands.create.md b/docs/api_reference/trestle.core.commands.create.md
diff --git a/docs/api_reference/trestle.core.commands.describe.md b/docs/api_reference/trestle.core.commands.describe.md
diff --git a/docs/api_reference/trestle.core.commands.href.md b/docs/api_reference/trestle.core.commands.href.md
diff --git a/docs/api_reference/trestle.core.commands.import_.md b/docs/api_reference/trestle.core.commands.import_.md
diff --git a/docs/api_reference/trestle.core.commands.init.md b/docs/api_reference/trestle.core.commands.init.md
diff --git a/docs/api_reference/trestle.core.commands.merge.md b/docs/api_reference/trestle.core.commands.merge.md
diff --git a/docs/api_reference/trestle.core.commands.partial_object_validate.md b/docs/api_reference/trestle.core.commands.partial_object_validate.md
diff --git a/docs/api_reference/trestle.core.commands.remove.md b/docs/api_reference/trestle.core.commands.remove.md
diff --git a/docs/api_reference/trestle.core.commands.replicate.md b/docs/api_reference/trestle.core.commands.replicate.md
diff --git a/docs/api_reference/trestle.core.commands.split.md b/docs/api_reference/trestle.core.commands.split.md
diff --git a/docs/api_reference/trestle.core.commands.task.md b/docs/api_reference/trestle.core.commands.task.md
diff --git a/docs/api_reference/trestle.core.commands.validate.md b/docs/api_reference/trestle.core.commands.validate.md
diff --git a/docs/api_reference/trestle.core.commands.version.md b/docs/api_reference/trestle.core.commands.version.md
diff --git a/docs/api_reference/trestle.core.control_context.md b/docs/api_reference/trestle.core.control_context.md
diff --git a/docs/api_reference/trestle.core.control_interface.md b/docs/api_reference/trestle.core.control_interface.md
diff --git a/docs/api_reference/trestle.core.control_reader.md b/docs/api_reference/trestle.core.control_reader.md
diff --git a/docs/api_reference/trestle.core.control_writer.md b/docs/api_reference/trestle.core.control_writer.md
diff --git a/docs/api_reference/trestle.core.crm.bycomp_interface.md b/docs/api_reference/trestle.core.crm.bycomp_interface.md
diff --git a/docs/api_reference/trestle.core.crm.export_reader.md b/docs/api_reference/trestle.core.crm.export_reader.md
diff --git a/docs/api_reference/trestle.core.crm.export_writer.md b/docs/api_reference/trestle.core.crm.export_writer.md
diff --git a/docs/api_reference/trestle.core.crm.leveraged_statements.md b/docs/api_reference/trestle.core.crm.leveraged_statements.md
diff --git a/docs/api_reference/trestle.core.crm.ssp_inheritance_api.md b/docs/api_reference/trestle.core.crm.ssp_inheritance_api.md
diff --git a/docs/api_reference/trestle.core.docs_control_writer.md b/docs/api_reference/trestle.core.docs_control_writer.md
diff --git a/docs/api_reference/trestle.core.draw_io.md b/docs/api_reference/trestle.core.draw_io.md
diff --git a/docs/api_reference/trestle.core.duplicates_validator.md b/docs/api_reference/trestle.core.duplicates_validator.md
diff --git a/docs/api_reference/trestle.core.generators.md b/docs/api_reference/trestle.core.generators.md
diff --git a/docs/api_reference/trestle.core.generic_oscal.md b/docs/api_reference/trestle.core.generic_oscal.md
diff --git a/docs/api_reference/trestle.core.jinja.base.md b/docs/api_reference/trestle.core.jinja.base.md
diff --git a/docs/api_reference/trestle.core.jinja.ext.md b/docs/api_reference/trestle.core.jinja.ext.md
diff --git a/docs/api_reference/trestle.core.jinja.filters.md b/docs/api_reference/trestle.core.jinja.filters.md
diff --git a/docs/api_reference/trestle.core.jinja.tags.md b/docs/api_reference/trestle.core.jinja.tags.md
diff --git a/docs/api_reference/trestle.core.links_validator.md b/docs/api_reference/trestle.core.links_validator.md
diff --git a/docs/api_reference/trestle.core.markdown.base_markdown_node.md b/docs/api_reference/trestle.core.markdown.base_markdown_node.md
diff --git a/docs/api_reference/trestle.core.markdown.control_markdown_node.md b/docs/api_reference/trestle.core.markdown.control_markdown_node.md
diff --git a/docs/api_reference/trestle.core.markdown.docs_markdown_node.md b/docs/api_reference/trestle.core.markdown.docs_markdown_node.md
diff --git a/docs/api_reference/trestle.core.markdown.markdown_api.md b/docs/api_reference/trestle.core.markdown.markdown_api.md
diff --git a/docs/api_reference/trestle.core.markdown.markdown_const.md b/docs/api_reference/trestle.core.markdown.markdown_const.md
diff --git a/docs/api_reference/trestle.core.markdown.markdown_processor.md b/docs/api_reference/trestle.core.markdown.markdown_processor.md
diff --git a/docs/api_reference/trestle.core.markdown.markdown_validator.md b/docs/api_reference/trestle.core.markdown.markdown_validator.md
diff --git a/docs/api_reference/trestle.core.markdown.md_writer.md b/docs/api_reference/trestle.core.markdown.md_writer.md
diff --git a/docs/api_reference/trestle.core.models.actions.md b/docs/api_reference/trestle.core.models.actions.md
diff --git a/docs/api_reference/trestle.core.models.elements.md b/docs/api_reference/trestle.core.models.elements.md
diff --git a/docs/api_reference/trestle.core.models.file_content_type.md b/docs/api_reference/trestle.core.models.file_content_type.md
diff --git a/docs/api_reference/trestle.core.models.interfaces.md b/docs/api_reference/trestle.core.models.interfaces.md
diff --git a/docs/api_reference/trestle.core.models.plans.md b/docs/api_reference/trestle.core.models.plans.md
diff --git a/docs/api_reference/trestle.core.object_factory.md b/docs/api_reference/trestle.core.object_factory.md
diff --git a/docs/api_reference/trestle.core.parser.md b/docs/api_reference/trestle.core.parser.md
diff --git a/docs/api_reference/trestle.core.pipeline.md b/docs/api_reference/trestle.core.pipeline.md
diff --git a/docs/api_reference/trestle.core.plugins.md b/docs/api_reference/trestle.core.plugins.md
diff --git a/docs/api_reference/trestle.core.profile_resolver.md b/docs/api_reference/trestle.core.profile_resolver.md
diff --git a/docs/api_reference/trestle.core.refs_validator.md b/docs/api_reference/trestle.core.refs_validator.md
diff --git a/docs/api_reference/trestle.core.remote.cache.md b/docs/api_reference/trestle.core.remote.cache.md
diff --git a/docs/api_reference/trestle.core.repository.md b/docs/api_reference/trestle.core.repository.md
diff --git a/docs/api_reference/trestle.core.resolver.merge.md b/docs/api_reference/trestle.core.resolver.merge.md
diff --git a/docs/api_reference/trestle.core.resolver.modify.md b/docs/api_reference/trestle.core.resolver.modify.md
diff --git a/docs/api_reference/trestle.core.resolver.prune.md b/docs/api_reference/trestle.core.resolver.prune.md
diff --git a/docs/api_reference/trestle.core.rule_parameters_validator.md b/docs/api_reference/trestle.core.rule_parameters_validator.md
diff --git a/docs/api_reference/trestle.core.ssp_io.md b/docs/api_reference/trestle.core.ssp_io.md
diff --git a/docs/api_reference/trestle.core.trestle_base_model.md b/docs/api_reference/trestle.core.trestle_base_model.md
diff --git a/docs/api_reference/trestle.core.validator.md b/docs/api_reference/trestle.core.validator.md
diff --git a/docs/api_reference/trestle.core.validator_factory.md b/docs/api_reference/trestle.core.validator_factory.md
diff --git a/docs/api_reference/trestle.oscal.assessment_plan.md b/docs/api_reference/trestle.oscal.assessment_plan.md
diff --git a/docs/api_reference/trestle.oscal.assessment_results.md b/docs/api_reference/trestle.oscal.assessment_results.md
diff --git a/docs/api_reference/trestle.oscal.catalog.md b/docs/api_reference/trestle.oscal.catalog.md
diff --git a/docs/api_reference/trestle.oscal.common.md b/docs/api_reference/trestle.oscal.common.md
diff --git a/docs/api_reference/trestle.oscal.component.md b/docs/api_reference/trestle.oscal.component.md
diff --git a/docs/api_reference/trestle.oscal.poam.md b/docs/api_reference/trestle.oscal.poam.md
diff --git a/docs/api_reference/trestle.oscal.profile.md b/docs/api_reference/trestle.oscal.profile.md
diff --git a/docs/api_reference/trestle.oscal.ssp.md b/docs/api_reference/trestle.oscal.ssp.md
diff --git a/docs/api_reference/trestle.tasks.base_task.md b/docs/api_reference/trestle.tasks.base_task.md
diff --git a/docs/api_reference/trestle.tasks.cis_xlsx_to_oscal_catalog.md b/docs/api_reference/trestle.tasks.cis_xlsx_to_oscal_catalog.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -51,3 +51,5 @@ tmp_bin_test

		/venv.trestle/

		# mkdocs
		.cache/