doc index.rst:
1. Correct heading levels (impacting side nav and correct rendering of content)
2. Remove "Indices and Tables" section: genindex page not used, move search link to intro sentence.
spec instructions.rst:
1. Update page title to be consistent w/ incoming link text (so that link with text "How to submit a spec" goes to a page titled "Submit a Spec")
2. Add section header to first list on page
Change-Id: Ic3071bcf1c8d152c68d6735f08bb97e768aa944f
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This will check the specs for the following when running tox:
linters runtests: commands[1] | doc8 specs/
Scanning...
Validating...
========
Total files scanned = 7
Total files ignored = 0
Total accumulated errors = 0
Detailed error counts:
- CheckCarriageReturn = 0
- CheckIndentationNoTab = 0
- CheckMaxLineLength = 0
- CheckNewlineEndOfFile = 0
- CheckTrailingWhitespace = 0
- CheckValidity = 0
Also fixes:
- One long line violation in instructions.rst
- DOS CRLF formatting of
containerization-2002840-local-docker-registry.rst
Change-Id: I73e1c87401156fe1fd52ab2b5460201f559c6284
Signed-off-by: Robert Church <robert.church@windriver.com>
Eventually we'll have multiple releases, so let's create per-release
subdirectories such that we can track which specs were approved/implemented
in each release.
Change-Id: Iadbd4a73701d01a5c88ab5414e2b607eab779357
Updating the spec naming convention in instructions.rst
and STX_Example_Spec.rst
Change-Id: I2f414bafe6efa6bea7604e9423e88c1932a50a7a
Signed-off-by: Frank Miller <frank.miller@windriver.com>
Kristal Dale