Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add doc tests, make them pass. #2890

Merged
merged 3 commits into from
Nov 4, 2023
Merged

Add doc tests, make them pass. #2890

merged 3 commits into from
Nov 4, 2023

Conversation

Julian-O
Copy link
Contributor

  • push.yml

    • Added documentation step which installs [docs], checks links and builds documentation to find any RST file errors.
    • Need to install to get all the dependencies, because p4a code is imported during doc generation.
    • Updated rest of checkout action versions to be consistent with new code.

  • apis.rst

    • http -> https
    • Disambiguated two modules with the same name.

  • buildoptions.rst

    • Corrected indenting

  • conf.py

    • Added language
    • Added two URLS to ignore; link-checker was failing them even though they worked.

  • ext/sphinix_rtd_theme/*

    • Old theme did not work with Sphinx 7.0+.
    • Removed it from source control. Install the latest each time.

  • launcher.rst

    • This described an old feature that hasn't worked for years. Couldn't fix the links because the whole feature is gone now. Removed it. If the attempts to bring the feature back ever come to fruition, this can be restored and edited.

  • index.rst

    • Removed no-longer-existing anchor
    • Removed launcher page

  • quickstart.rst

    • Removed launcher

  • recipe.rst

    • Fixed syntax error in rst.

  • services,rst

    • Fixed broken URL (and linked to project rather than bug-tracker.)

  • troubleshooting.rst

    • http->https
    • Link to English rather than Chinese web-sites.

  • setup.py

    • Add docs as extra.

@Julian-O
Add doc tests, make them pass
adfee4d 
* push.yml
   * Added documentation step which installs [docs], checks links and builds documentation to find any errors.
   * Need to install to get all the dependencies, because p4a code is imported during doc generation.
   * Updated rest of checkout action versions to be consistent with new code.

* apis.rst
   * http -> https
   * Disambiguated two modules with the same name.

* buildoptions.rst
   * Corrected indenting

* conf,py
   * Added language
   * Added two URLS to ignore that link-checker was failing even though they worked.

* ext/sphinix_rtd_theme/*
   * Old theme did not work with Sphinx 7.0+.
   * Removed it from source control. Install the latest each time.

* launcher.rst
   * This described an old feature that hasn't worked for years. Couldn't fix the links because the whole feature is gone now. Removed it. If the attempts to bring the feature back ever come to fruition, this can be restored and edited.

* index.rst
   * Removed no-longer-existing anchor,
   * Removed launcher page

* quickstart.rst
   * Removed launcher

* recipe.rst
   * Fixed syntax error in rst.

* services,rst
   * Fixed broken URL (and linked to project rather than bug-tracker.)

* troubleshooting.rst
   * http->https
   * Link to English rather than Chinese web-sites.

* setup.py
   * Add docs as extra.
misl6
misl6 requested changes Sep 16, 2023
View reviewed changes
doc/source/index.rst Outdated Show resolved Hide resolved
doc/source/launcher.rst Show resolved Hide resolved
doc/source/apis.rst Outdated Show resolved Hide resolved
@Julian-O
Copy link
Contributor Author

Julian-O commented Oct 7, 2023

Just a note to say haven't forgotten this. On my to-do list to make the changes requested,

@misl6
Copy link
Member

misl6 commented Oct 7, 2023

Just a note to say haven't forgotten this. On my to-do list to make the changes requested,

Don't worry!

@Julian-O Julian-O requested a review from misl6 October 15, 2023 14:10
@Julian-O
Fix broken links in documentation.
ee4f655 
One dead link, causing test to fail.
Several permanent redirects where it is better to use the final destination.

The rest
misl6
misl6 approved these changes Nov 4, 2023
View reviewed changes
Copy link
Member

@misl6 misl6 left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you!

@misl6 misl6 merged commit 0be5572 into kivy:develop Nov 4, 2023
T-Dynamos pushed a commit to T-Dynamos/python-for-android that referenced this pull request Nov 18, 2023
@Julian-O @T-Dynamos
Improve docs, add docs tests and remove vendored theme (kivy#2890)
5c1727b 
* Add doc tests, make them pass

* push.yml
   * Added documentation step which installs [docs], checks links and builds documentation to find any errors.
   * Need to install to get all the dependencies, because p4a code is imported during doc generation.
   * Updated rest of checkout action versions to be consistent with new code.

* apis.rst
   * http -> https
   * Disambiguated two modules with the same name.

* buildoptions.rst
   * Corrected indenting

* conf,py
   * Added language
   * Added two URLS to ignore that link-checker was failing even though they worked.

* ext/sphinix_rtd_theme/*
   * Old theme did not work with Sphinx 7.0+.
   * Removed it from source control. Install the latest each time.

* launcher.rst
   * This described an old feature that hasn't worked for years. Couldn't fix the links because the whole feature is gone now. Removed it. If the attempts to bring the feature back ever come to fruition, this can be restored and edited.

* index.rst
   * Removed no-longer-existing anchor,
   * Removed launcher page

* quickstart.rst
   * Removed launcher

* recipe.rst
   * Fixed syntax error in rst.

* services,rst
   * Fixed broken URL (and linked to project rather than bug-tracker.)

* troubleshooting.rst
   * http->https
   * Link to English rather than Chinese web-sites.

* setup.py
   * Add docs as extra.

* Updated with review comments.

* Fix broken links in documentation.

One dead link, causing test to fail.
Several permanent redirects where it is better to use the final destination.

The rest
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@misl6 misl6 misl6 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Julian-O @misl6