Skip to content

Documentation: Add instructions for setting up a Sphinx env through MacPorts to the Contributor's Guide #2921

@jprestop

Description

@jprestop

Describe the Task

Add instructions for setting up a Sphinx env through MacPorts to the Contributor's Guide:
As <admin user>:
sudo port install python312
sudo port select --set python python312
sudo port select --set python3 python312

sudo port install py312-sphinx
sudo port select --set python python312
sudo port select --set sphinx py312-sphinx
sudo port install py312-dateutil

As <regular user>:
python3 -m ensurepip --default-pip
python3 -m pip install sphinx_design sphinx_rtd_theme sphinx-gallery sphinx-copybutton

Time Estimate

<1 day

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

None

Funding Source

NOAA base

Define the Metadata

Assignee

  • Select appropriate assignee for this issue

Labels

  • Review default alert labels
  • Select component(s)
  • Select priority
  • Select requestor(s)

Milestone and Projects

  • Select Milestone as a METplus-Wrappers-X.Y.Z version, Consider for Next Release, or Backlog of Development Ideas
  • For a METplus-Wrappers-X.Y.Z version, select the METplus-Wrappers-X.Y.Z Development project

Define Related Issue(s)

Consider the impact to the other METplus components.

Task Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Add any new Python packages to the METplus Components Python Requirements table.
  • For any new datasets, an entry to the METplus Verification Datasets Guide.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issue
    Select: Milestone as the next official version
    Select: METplus-Wrappers-X.Y.Z Development project for development toward the next official release
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.

Metadata

Metadata

Assignees

Type

No type

Projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions