Clean up default rosdoc2.yaml to show all available options, but commented out.

rosdoc2/verbs/build/builder.py

@@ -25,15 +25,8 @@ class Builder:
     def __init__(self, builder_name, builder_entry_dictionary, build_context):
         """Construct a new Builder."""
         self.builder_type = builder_name
-
-        if 'name' not in builder_entry_dictionary:
-            raise RuntimeError("Error entry without 'name' field found")
-        self.name = builder_entry_dictionary['name']
-
-        if 'output_dir' not in builder_entry_dictionary:
-            raise RuntimeError("Error entry without 'output_dir' field found")
-        self.output_dir = builder_entry_dictionary['output_dir']
-
+        self.name = builder_entry_dictionary.get('name')
+        self.output_dir = builder_entry_dictionary.get('output_dir')
         self.builder_entry_dictionary = builder_entry_dictionary
         self.build_context = build_context
 

rosdoc2/verbs/build/builders/doxygen_builder.py

@@ -79,6 +79,8 @@ def __init__(self, builder_name, builder_entry_dictionary, build_context):
             build_context)
 
         assert self.builder_type == 'doxygen'
+        self.name = self.name or self.build_context.package.name + ' Public C/C++ API'
+        self.output_dir = self.output_dir or 'generated/doxygen'
 
         # If the build type is not `ament_cmake/cmake`, there is no reason
         # to create a doxygen builder.
@@ -101,6 +103,8 @@ def __init__(self, builder_name, builder_entry_dictionary, build_context):
             if key in ['name', 'output_dir']:
                 continue
             if key == 'doxyfile':
+                if not value:
+                    continue
                 config_file_dir = os.path.dirname(configuration_file_path)
                 doxyfile = os.path.join(config_file_dir, value)
                 if not os.path.exists(doxyfile):

rosdoc2/verbs/build/builders/sphinx_builder.py

@@ -335,8 +335,13 @@ def __init__(self, builder_name, builder_entry_dictionary, build_context):
 
         assert self.builder_type == 'sphinx'
 
+        self.name = self.name or self.build_context.package.name
+        self.output_dir = self.output_dir or ''
         self.sphinx_sourcedir = None
-        self.doxygen_xml_directory = None
+
+        # Must check for the existence of this later, as it may not have been made yet.
+        self.doxygen_xml_directory = \
+            builder_entry_dictionary.get('doxygen_xml_directory', 'generated/doxygen/xml')
         configuration_file_path = build_context.configuration_file_path
         if not os.path.exists(configuration_file_path):
             # This can be the case if the default config is used from a string.
@@ -346,7 +351,7 @@ def __init__(self, builder_name, builder_entry_dictionary, build_context):
 
         # Process keys.
         for key, value in builder_entry_dictionary.items():
-            if key in ['name', 'output_dir']:
+            if key in ['name', 'output_dir', 'doxygen_xml_directory']:
                 continue
             if key == 'sphinx_sourcedir':
                 sphinx_sourcedir = os.path.join(configuration_file_dir, value)
@@ -355,9 +360,6 @@ def __init__(self, builder_name, builder_entry_dictionary, build_context):
                         f"Error Sphinx SOURCEDIR '{value}' does not exist relative "
                         f"to '{configuration_file_path}', or is not a directory.")
                 self.sphinx_sourcedir = sphinx_sourcedir
-            elif key == 'doxygen_xml_directory':
-                self.doxygen_xml_directory = value
-                # Must check for the existence of this later, as it may not have been made yet.
             else:
                 raise RuntimeError(f"Error the Sphinx builder does not support key '{key}'")
 

rosdoc2/verbs/build/create_format_map_from_package.py

@@ -22,4 +22,5 @@ def create_format_map_from_package(package):
         'package_version': package.version,
         'package_description': package.description,
         'package_directory': os.path.abspath(os.path.dirname(package.filename)),
+        'package_build_type': package.get_build_type()
     }

rosdoc2/verbs/build/impl.py

@@ -178,10 +178,6 @@ def main_impl(options):
             source=doc_output_directory,
             destination=builder_destination)
 
-    # If enabled, create package index.
-    if tool_settings.get('generate_package_index', True):
-        pass
-
     # Move staged files to user provided output directory.
     package_output_directory = os.path.join(options.output_directory, package.name)
     logger.info(f"Moving files to final destination in '{package_output_directory}'.")

rosdoc2/verbs/build/inspect_package_for_settings.py

@@ -27,65 +27,56 @@
 
 ---
 
-settings:
-    ## If this is true, a standard index page is generated in the output directory.
-    ## It uses the package information from the 'package.xml' to show details
-    ## about the package, creates a table of contents for the various builders
-    ## that were run, and may contain links to things like build farm jobs for
-    ## this package or links to other versions of this package.
-
-    ## If false, you can still include content that would have been in the index
-    ## into one of your '.rst' files from your Sphinx project, using the
-    ## '.. include::' directive in Sphinx.
-    ## For example, you could include it in a custom 'index.rst' so you can have
-    ## the standard information followed by custom content.
-
-    ## TODO(wjwwood): provide a concrete example of this (relative path?)
-
-    ## If this is not specified explicitly, it defaults to 'true'.
-    generate_package_index: true
-
+settings: {{
     ## This setting is relevant mostly if the standard Python package layout cannot
     ## be assumed for 'sphinx-apidoc' invocation. The user can provide the path
     ## (relative to the 'package.xml' file) where the Python modules defined by this
     ## package are located.
-    # python_source: '{package_name}'
+    # python_source: '{package_name}',
 
     ## This setting, if true, attempts to run `doxygen` and the `breathe`/`exhale`
     ## extensions to `sphinx` regardless of build type. This is most useful if the
     ## user would like to generate C/C++ API documentation for a package that is not
     ## of the `ament_cmake/cmake` build type.
-    always_run_doxygen: false
+    # always_run_doxygen: false,
 
     ## This setting, if true, attempts to run `sphinx-apidoc` regardless of build
     ## type. This is most useful if the user would like to generate Python API
     ## documentation for a package that is not of the `ament_python` build type.
-    always_run_sphinx_apidoc: false
+    # always_run_sphinx_apidoc: false,
 
     # This setting, if provided, will override the build_type of this package
     # for documentation purposes only. If not provided, documentation will be
     # generated assuming the build_type in package.xml.
-    # override_build_type: 'ament_python'
+    # override_build_type: '{package_build_type}',
+}}
 builders:
     ## Each stanza represents a separate build step, performed by a specific 'builder'.
     ## The key of each stanza is the builder to use; this must be one of the
     ## available builders.
     ## The value of each stanza is a dictionary of settings for the builder that
     ## outputs to that directory.
-    ## Required keys in the settings dictionary are:
+    ## Keys in all settings dictionary are:
     ##  * 'output_dir' - determines output subdirectory for builder instance
     ##                   relative to --output-directory
     ##  * 'name' - used when referencing the built docs from the index.
 
     - doxygen: {{
-        name: '{package_name} Public C/C++ API',
-        output_dir: 'generated/doxygen'
+        # name: '{package_name} Public C/C++ API',
+        # output_dir: 'generated/doxygen',
+        ## file name for a user-supplied Doxyfile
+        # doxyfile: null,
+        ## additional statements to add to the Doxyfile, list of strings
+        # extra_doxyfile_statements: [],
       }}
     - sphinx: {{
-        name: '{package_name}',
+        # name: '{package_name}',
         ## This path is relative to output staging.
-        doxygen_xml_directory: 'generated/doxygen/xml',
-        output_dir: ''
+        # doxygen_xml_directory: 'generated/doxygen/xml',
+        # output_dir: '',
+        ## Root folder for the user-supplied documentation. If not specified, either 'doc' or
+        ## 'doc/source' will be used if renderable documentation is found there.
+        # sphinx_sourcedir: 'doc',
       }}
 """
 

rosdoc2/verbs/build/parse_rosdoc2_yaml.py

@@ -57,6 +57,7 @@ def parse_rosdoc2_yaml(yaml_string, build_context):
             f'expected a dict{{output_dir: build_settings, ...}}, '
             f"got a '{type(settings_dict)}' instead")
 
+    # if None, python_source is set to either './<package.name>' or 'src/<package.name>'
     build_context.python_source = settings_dict.get('python_source', None)
     build_context.always_run_doxygen = settings_dict.get('always_run_doxygen', False)
     build_context.always_run_sphinx_apidoc = settings_dict.get('always_run_sphinx_apidoc', False)

test/packages/default_yaml/Changelog.rst

@@ -0,0 +1 @@
+This should have a changelog.

test/packages/default_yaml/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.