snooty-parser

Added

• Homepage directives (DOP-1120).

Changed

• The rfc role is now an extlink and actually creates a reference (DOP-1128).

Fixed

• Invalid YAML in tabs and card groups no longer triggers a crash (DOP-1135).

Changed

• Error code 2 is now returned if there are error diagnostics, leaving error code 1 for crashes (DOP-922).

Fixed

• Generated intersphinx inventories are now compatible with older versions of Sphinx (DOP-1094).
• Snooty no longer crashes when generating or loading an intersphinx inventory with invalid target names (DOP-1079).
• Diagnostic levels are now dealt with more carefully.

Added

• Support for the glossery directive (DOP-888).
• Optional support for logging diagnostics as JSON objects (DOP-969).

Changed

• The optional patch ID is now written to the metadata document.

Fixed

• Support for links in step file headings (DOP-1015).
• Incorrect AST output with hyperlink references (DOP-1056).

Added

• Support for deprecated versions (DOP-908).

Fixed

• Definition list AST format.
• The code block linenos option is now correctly placed in the AST node.

Added

• All roles, directives, & rstobjects from v0.4.3.

Added

• Added spec role.
• Added support for various roles & directive options.
• Added support for passing a patch ID into the build identifier (DOP-948).
• The std:doc role now emits RefRole nodes rather than Role, and titles are now
  resolved in the parser (DOP-954).

Changed

• Diagnostic refactoring (DOP-878).
• The doc role is now in the std domain.

Added

• Various roles.

Changed

• C# driver extlinks now point to 2.10.
• Scala driver extlinks now point to 2.9.

Added

• Various roles and directive options.

Changed

• Prefer canonical target names in the AST: e.g. mongod.-v over -v (DOP-881).

Fixed

• Skip incomplete target nodes, resolving a crash. (DOP-891).

Added

• Program & Option handling (DOCSP-8449).
• Enforce ISO 8061 dates (DOCSPLAT-825).
• Support multiple authors.
• Various roles & directives.

Changed

• The AST is now constructed with a formally specified object-oriented structure.

Fixed

• Fix ref_role nodes with an explicit title.

Added

• Populate substitution nodes in postprocess layer (DOCSPLAT-114).

Fixed

• Fix devhub image handling (DOCSPLAT-861).

[v0.3.4] - 2020-02-27

Removed

• DevHub series directive.

Added

• Directives for DevHub (DOCSP-8848).
• Tab sets for Realm (DOCSP-8787).

Added

• Support for defining a project's title (DOCSP-7988).
• Support for defining a project's default domain (DOCSP-8723).
• Support for DevHub template directives (DOCSP-8723).
• Support for Python 3.8 (DOCSP-7399).
• Support for injecting formatting into ref_role nodes (DOCSP-7569).

Changed

• Incomplete targets are now an error: for example,

  `universal link <ios-universal-links_>`_
  

Fixed

• Directives may now have a "name" option, suppressing the docutils
  special-case behavior.
• Fix crashing around snooty.toml (DOCSP-8389).

Added

• Target/Ref validation & resolution (DOCSP-5776, DOCSP-6657).

• Commit IDs may now be passed into the parser (DOCSP-8277).

Changed

• Domains are now included in AST nodes when relevant.

Added

• Support for defining non-drawer TOC nodes via toc_landing_pages array in snooty.toml (DOCSP-7573).

Fixed

• Inconsistent YAML output filenames leading to broken page previews (DOCSP-8084).

Added

• The following extlink roles:

  • fb-dev-docs
  • fcm
  • google-dev
  • google-android-ref
  • github
  • github-dev
  • electricimp
  • twilio
  • mdn
  • aws-go
  • aws-iam
  • aws-reference
  • reactjs
  • jwt-io

• More semantic analysis postprocessing infrastructure (DOCSP-7574).

• A new release process (DOCSP-7800).

Added

• Added infrastructure to support editor preview.

• Added infrastructure to support TOC generation.

• Added diagnostic for merge conflict markers.

• Parse published-branches.yaml and persist data to a metadata collection (DOCSP-7193).

Fixed

• Parsing of extract filenames that include periods (DOCSP-6904).

• Miscellaneous reStructuredText support improvements.

• Properly report snooty.toml errors.

Added

• Support for reStructuredText footnotes (DOCSP-6620).

• Support for project-wide reStructuredText substitutions (DOCSP-6442).

• Support for downloading and ingesting intersphinx inventories (DOCSP-5776).

• Validation for links under the doc role (DOCSP-6190).

• Support for the following reStructuredText constructs:

  • datalakeconf rstobject
  • caption option to toctree
  • includehidden option to toctree
  • backlinks option to contents is an enum
  • gcp and azure extlinks
  • only directive
  • tab directive accepts a tabid option (DOCSP-6493)
  • list-table directive accepts an argument (DOCSP-6554)
  • card-group directive (DOCSP-6447)

Changed

• The original filename of static assets is now saved in the filename field of the
  snooty.assets collection, replacing the type field (DOCSP-6849).
• Directive "flag" options have a true value in the AST instead of null (DOCSP-6383).
• The "only" directive is now deprecated in favor of "cond".

Fixed

• Parsing of the versionadded, versionchanged, and deprecated directives (DOCSP-6504).