Skip to content

Fix doc warnings and enable errors.#1419

Merged
TheRealFalcon merged 1 commit into
canonical:mainfrom
aciba90:sc-894/Fix_warnings_in_docs
Apr 29, 2022
Merged

Fix doc warnings and enable errors.#1419
TheRealFalcon merged 1 commit into
canonical:mainfrom
aciba90:sc-894/Fix_warnings_in_docs

Conversation

@aciba90
Copy link
Copy Markdown
Contributor

@aciba90 aciba90 commented Apr 29, 2022

Proposed Commit Message

Fix doc warnings

- Remove Sphinx build warnings
- Turn Sphinx warnings into errors

LP: #1876341
SC-894

Checklist:

  • My code follows the process laid out in the documentation
  • I have updated or added any unit tests accordingly
  • I have updated or added any documentation accordingly

@@ -59,14 +59,6 @@ Run commands on first boot
:language: yaml
:linenos:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These two example files did not exist since a while ago. Only the titles were rendered.

Data is sent as ``x-www-form-urlencoded`` arguments.

**Example HTTP POST**::
**Example HTTP POST**:
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In order to modify the global literal highlight language (yaml in our case) we have to use an explicit code-block directive.

literal-blocks

Copy link
Copy Markdown
Contributor

@TheRealFalcon TheRealFalcon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work! Some of the warnings were legitimate issues, so I'm glad we got that fixed.

@TheRealFalcon TheRealFalcon merged commit e1046bb into canonical:main Apr 29, 2022
@aciba90 aciba90 deleted the sc-894/Fix_warnings_in_docs branch April 29, 2022 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants