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

make help #5258

Merged
merged 5 commits into from
Apr 20, 2023
Merged

make help #5258

merged 5 commits into from
Apr 20, 2023

Conversation

tkknight
Copy link
Contributor

🚀 Pull Request

Description

  • The command make help now lists all the appropriate commands available as a make target.
  • Removed unused targets
  • Added livehtml target, this monitors for changes in the source and auto builds and serves the content.
$  make help
Please use `make <target>' where <target> is one of
  help         to view this help
  html         to make standalone HTML files
  html-noplot  to make standalone HTML files, skip gallery
  html-noapi   to make standalone HTML files, skip the API
  html-quick   to make standalone HTML files, skip the gallery and API
  clean        to remove all built files
  doctest      to run all doctests embedded in the documentation (if enabled)
  linkcheck    to check all external links for integrity
  show         to open the built documentation in the default browser
  livehtml     to auto build the docs when any file changes are detected.
               You need to install sphinx-autobuild first:
                   conda install -c conda-forge sphinx-autobuild

Consult Iris pull request check list

* upstream/main:
  review actions
  update .git-blame-ignore-revs
  adopt codespell
  Adopt sphinx design (SciTools#5127)
  Bump scitools/workflows from 2023.04.2 to 2023.04.3 (SciTools#5253)
@codecov
Copy link

codecov bot commented Apr 18, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (2eac400) 89.31% compared to head (ad9c579) 89.31%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5258   +/-   ##
=======================================
  Coverage   89.31%   89.31%           
=======================================
  Files          88       88           
  Lines       22279    22279           
  Branches     4881     4881           
=======================================
  Hits        19898    19898           
  Misses       1635     1635           
  Partials      746      746           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@bjlittle bjlittle self-assigned this Apr 18, 2023
@bjlittle bjlittle self-requested a review April 18, 2023 21:27
@tkknight tkknight marked this pull request as ready for review April 19, 2023 08:06
docs/Makefile Outdated Show resolved Hide resolved
Copy link
Member

@bjlittle bjlittle left a comment

Choose a reason for hiding this comment

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

@tkknight Rock'n roll 🎸 🤟

Nice addition, thanks!

I'm so using make show now 🤩

@bjlittle bjlittle merged commit e48ea5e into SciTools:main Apr 20, 2023
tkknight added a commit to tkknight/iris that referenced this pull request Apr 22, 2023
* upstream/main: (61 commits)
  Updated environment lockfiles (SciTools#5270)
  Drop python3.8 support (SciTools#5269)
  build wheel from sdist, not src (SciTools#5266)
  Lazy netcdf saves (SciTools#5191)
  move setup.cfg to pyproject.toml (SciTools#5262)
  Support Python 3.11 (SciTools#5226)
  Remove Resolve test workaround (SciTools#5267)
  add missing whatsnew entry (SciTools#5265)
  make help (SciTools#5258)
  automate pypi manifest checking (SciTools#5259)
  drop sphinxcontrib-napoleon (SciTools#5263)
  add missing test result data (SciTools#5260)
  fix indentation and remove ref to ssstack (SciTools#5256)
  review actions
  update .git-blame-ignore-revs
  adopt codespell
  Adopt sphinx design (SciTools#5127)
  Bump scitools/workflows from 2023.04.2 to 2023.04.3 (SciTools#5253)
  refresh manual pypi publish instructions (SciTools#5252)
  Updated environment lockfiles (SciTools#5250)
  ...
@tkknight tkknight deleted the docs_make_help branch November 9, 2023 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants