• 
      

    Add a code reference for RBTools.

    Review Request #12519 — Created Aug. 9, 2022 and submitted

    Information

    RBTools
    release-3.x

    Reviewers

    Despite the fact that RBTools provides APIs for talking to Review Board
    and implementing custom commands and clients, we haven't documented the
    codebase publicly.

    This adds a code reference to the documentation's API section, and fixes
    some syntax errors in the docs that were found during generation. We're
    now using Sphinx 5.0, and beanbag-docutils 2.0, to build the
    documentation.

    There's a lot that needs to be done to clean up documentation in the
    codebase, but that's work that can be done over time.

    Built the docs. There are still warnings, but they'd require more
    extensive work.

    Summary ID
    Add a code reference for RBTools.
    Despite the fact that RBTools provides APIs for talking to Review Board and implementing custom commands and clients, we haven't documented the codebase publicly. This adds a code reference to the documentation's API section, and fixes some syntax errors in the docs that were found during generation. We're now using Sphinx 5.0, and beanbag-docutils 2.0, to build the documentation. There's a lot that needs to be done to clean up documentation in the codebase, but that's work that can be done over time.
    86751dba1d3a17770eefd5ba370885b31fb2169c
    Description From Last Updated

    Can we fix this up to actually use our docstring standards?

    daviddavid
    david
    1. 
        
    2. rbtools/utils/checks.py (Diff revision 1)
       
       
       
       
       
       
       
      Show all issues

      Can we fix this up to actually use our docstring standards?

      1. I'm going to be getting rid of it. I just wanted it to stop erroring out.

    3. 
        
    david
    1. Ship It!
    2. 
        
    chipx86
    Review request changed
    Status:
    Completed
    Change Summary:
    Pushed to release-4.x (95dbf72)