Package software.amazon.smithy.docgen.sections.sphinx

Record Class RequirementsSection

java.lang.Object
java.lang.Record
software.amazon.smithy.docgen.sections.sphinx.RequirementsSection
Record Components:
context - The context used to generate documentation.
requirements - The requirements as a list of PEP 508 strings.
All Implemented Interfaces:
CodeSection
public record RequirementsSection(DocGenerationContext context, Set<String> requirements) extends Record implements CodeSection
Generates a requirements file needed to install and run sphinx.

Any requirements added here will be installed in the environment used to automatically build the docs with sphinx-build.

  • Constructor Details

    • RequirementsSection

      public RequirementsSection(DocGenerationContext context, Set<String> requirements)
      Creates an instance of a RequirementsSection record class.
      Parameters:
      context - the value for the context record component
      requirements - the value for the requirements record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • context

      public DocGenerationContext context()
      Returns the value of the context record component.
      Returns:
      the value of the context record component

    • requirements

      public Set<String> requirements()
      Returns the value of the requirements record component.
      Returns:
      the value of the requirements record component