updates branch#419
Merged
Merged
Conversation
* Simplify vale binary install * Use `vale --version` only to trigger binary download & install * Don't direct output to /dev/null to show potential problems * Update version --------- Co-authored-by: Michael Park <michael.park@canonical.com>
* Remove impossible warning It's impossible to skip heading levels in reST (it's designed to avoid this as several of its output formats cannot skip levels either, due to recursive section structures). * Correct underline definition reST permits heading underlines to be longer than the corresponding title, which some authors find convenient (i.e. it's fine to just use a full line of "=") https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#sections * Only use admonitions advised by the style guide The general style guide at https://docs.ubuntu.com/styleguide/en advises under the admonitions section that only the "warning" and "information" admonition callouts are permitted. Given "information" doesn't exist in reST, "note" is probably the next best thing. Changed "caution" to "warning" and removed "tip" and "important". * Add a section on linking to the Ubuntu man-pages * Add note about image output formats Using * as the image extension allows sphinx to pick the "best" image format for the output it's producing. For example, PNG for web, but embedded PS for PDF. * Fix md inclusion example * Apply rkratky's suggestions from code review Co-authored-by: Robert Krátký <robert.kratky@canonical.com> --------- Co-authored-by: Robert Krátký <robert.kratky@canonical.com>
* Doc: add instructions for configuring PDF build - explain latex_documents and how to change the Sphinx configurations - introduce methods for overriding LaTeX templates from the extension * fix: spelling * fix: spelling wordlist * use inclusive words * add notes about format of latex_additional_files * fix: spelling check
* run update only when version increases * add changelog entry
Changed README format to markdown for correct rendering in the GitHub UI. Updated the Structure section.
* docs: update toctree reference * feat: add sitemap support * docs: add changelog entry and bump version * Update docs/how-to/set-up-sitemaps.rst Co-authored-by: tang-mm <3333407+tang-mm@users.noreply.github.com> * feat: update sitemap documentation * fix: spelling * Update docs/how-to/set-up-sitemaps.rst * fix: formatting * docs: add link to sitemap config from docs * Update docs/conf.py --------- Co-authored-by: tang-mm <3333407+tang-mm@users.noreply.github.com>
* docs: update toctree reference * feat: add sitemap support * docs: add changelog entry and bump version * Update docs/how-to/set-up-sitemaps.rst Co-authored-by: tang-mm <3333407+tang-mm@users.noreply.github.com> * feat: update sitemap documentation * fix: spelling * Update docs/how-to/set-up-sitemaps.rst * fix: formatting * docs: add link to sitemap config from docs * Update docs/conf.py * Update set-up-sitemaps.rst * Update conf.py * fix: RTD versioned sitemaps --------- Co-authored-by: tang-mm <3333407+tang-mm@users.noreply.github.com>
* Clarify instructions for sitemaps * fix spelling error * Update docs/how-to/set-up-sitemaps.rst
Add guidance that instructs the developer to switch to the `dirhtml` builder if necessary. Certain old projects might still be using the `html` builder, which causes sitemap links to be malformed.
* fix: branch name in update script * update changelog
* feat: lastmod in sitemap * fix: spelling * Apply suggestions from code review Co-authored-by: Dave Wilding <tech@dpw.me> --------- Co-authored-by: Dave Wilding <tech@dpw.me>
* add workflow for checking CLA * add CLA requirement to readme
* Update Makefile Per @desrod's suggestion: Small changes to group .PHONY targets logically together and introduce proper, recursive ${MAKE} instead of statically calling 'make' each time through. More to time! * Update CHANGELOG.md Add changes regarding Makefile logic
* fix: markdown linting workflow * fix(ci): match all mardown documents Co-authored-by: Jeremie Deray <deray.jeremie@gmail.com> * fix: switch to pymarkdownlnt --------- Co-authored-by: Jeremie Deray <deray.jeremie@gmail.com> Co-authored-by: Michael Park <michael.park@canonical.com>
* docs/Makefile: do implicit venv support detection Opportunistically try to create the venv and if it fails, hint the user to install `python3-venv`. This avoids spawning another python3 process just for the detection. Signed-off-by: Simon Deziel <simon.deziel@canonical.com> * docs/Makefile: avoid `'` in comments Signed-off-by: Simon Deziel <simon.deziel@canonical.com> * docs/Makefile: prefer `command -v` to `type` Both are shell builtins but `type` is more for human and `command -v` for shell: ``` $ command -v python3; echo $? /usr/bin/python3 0 $ command -v python4; echo $? 1 ``` ``` $ type python3; echo $? python3 is /usr/bin/python3 0 $ type python4; echo $? bash: type: python4: not found 1 ``` Also, `command -v` does not emit anything on `stderr`, it just reflect the availability with its exit code. Signed-off-by: Simon Deziel <simon.deziel@canonical.com> --------- Signed-off-by: Simon Deziel <simon.deziel@canonical.com>
Signed-off-by: Minae Lee <minae.lee@canonical.com>
* Update set-up-automated-testing.rst * Update set-up-automated-testing.rst * Update .custom_wordlist.txt
* feat: replace spelling check with vale * chore: pin canonical-sphinx version to 0.5.0 release * chore: remove unnecessary files * chore: bump version * chore: change style guide repo address * docs: clarify syntax guides * docs: document vale exceptions and new spelling config * feat: add URL removal check * chore: remove wordlist * chore: update changelog * fix: linting and checks * fix: linting, spelling * fix: removes URL check * docs: sitemap exceptions * test: correct repo for URL removal check * docs: updates changelog * fix: adds redirect for removed URLs * fix(check-removed-urls): use the pull request base repo for the base … (#1) * fix(check-removed-urls): use the pull request base repo for the base branch * fix: use the full name and not the object * docs: syntax guide reference * chore: remove comment * chore: word additions for vale style linting * chore: unpin canonical-sphinx * Apply suggestions from code review Co-authored-by: Dave Wilding <tech@dpw.me> * Update contributing.rst * Apply suggestions from code review Co-authored-by: Michael DuBelko <michael.dubelko@gmail.com> * docs: add prompt to redirect removed pages in check * chore: remove spellcheck install * feat: keep alternate spellcheck command to warn of deprecation * fix: makefile backticks fix Co-authored-by: tang-mm <3333407+tang-mm@users.noreply.github.com> --------- Co-authored-by: Guillaume Beuzeboc <guillaume.beuzeboc@gmail.com> Co-authored-by: Dave Wilding <tech@dpw.me> Co-authored-by: Michael DuBelko <michael.dubelko@gmail.com> Co-authored-by: tang-mm <3333407+tang-mm@users.noreply.github.com>
* docs: update automatic_checks.rst * fix: update automatic_checks.rst remove woke prereqs * fix: update automatic_checks.rst make list distinction more clear * fix: update automatic_checks.rst fix code block formatting * fix: update automatic_checks.rst punctuation * fix: update docs/reference/automatic_checks.rst typo Co-authored-by: Sara <sara.feijoo@canonical.com> * fix: include suggestions to pr for automatic_checks.rst --------- Co-authored-by: Sara <sara.feijoo@canonical.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
17 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.