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.

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

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

Commits on Sep 14, 2023

  1. 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.
    Julian-O committed Sep 14, 2023
    Configuration menu
    Copy the full SHA
    adfee4d View commit details
    Browse the repository at this point in the history

Commits on Oct 15, 2023

  1. Configuration menu
    Copy the full SHA
    2153b5b View commit details
    Browse the repository at this point in the history
  2. 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
    Julian-O committed Oct 15, 2023
    Configuration menu
    Copy the full SHA
    ee4f655 View commit details
    Browse the repository at this point in the history