-
Story
-
Resolution: Done
-
Medium
-
None
-
None
-
None
-
DOC Sprint 8
In the doc project and related project repositories that provide documentation RST source, there will be no Sphinx html builder or link check builder errors/warnings in the Beijing branch.
Most existing errors / warnings will be eliminated by:
- Consistent use of a blank line to separate a current block from other markup or directives that imply start of a new block..
- Using balanced RST inline markup start/stop delimiters
- Referencing URLs that are valid or use a pattern that link check ignores (see line 380 linkcheck_ignore in sphinx configuration for the current list).
- Use of the sphinx code-block directives with "source code" that complies with the syntax of the language specified for the code-block. Source code in an rst file, outside of code-block directive and/or mixed languages within a code-block should be avoided. For example specifying a code-block of type http for a URL that contains some form of macro or variable substitution convention. If a code-block must contain content that is inconsistent with all code-block supported language types, specify "none" as the code-block language. A before/after example of code blocks to improve readability and eliminate errors/warnings in html and rst is attached.
- is blocked by
-
AAF-318 Fix Documentation RST Warnings
- Closed
-
APPC-918 Fix Documentation RST warnings and Linkcheck Errors
- Closed
-
DCAEGEN2-516 Fix Documentation RST Warnings
- Closed
-
MODELING-78 Fix Documentation RST Warnings
- Closed
-
MULTICLOUD-239 Fix Documentation RST warnings and Linkcheck Errors
- Closed
-
OPTFRA-242 Fix Documentation RST warnings and Linkcheck Errors
- Closed
-
VFC-919 Fix Documentation RST Warnings
- Closed
-
VNFRQTS-222 Fix Documentation RST Warnings
- Closed
-
VNFSDK-270 Fix Documentation RST Warnings
- Closed
-
AAI-1152 Eliminate Sphinx Errors/Warnings for Beijing Documentation
- Closed