Skip to content

Update documentation contributor guide#55

Merged
dprada merged 1 commit intomainfrom
codex/update-readme.md-with-comprehensive-guide
Nov 3, 2025
Merged

Update documentation contributor guide#55
dprada merged 1 commit intomainfrom
codex/update-readme.md-with-comprehensive-guide

Conversation

@dprada
Copy link
Collaborator

@dprada dprada commented Nov 3, 2025

Summary

  • replace the docs README stub with a detailed contributor guide for building and publishing documentation
  • highlight environment setup, notebook execution, autosummary cleanup, and GitHub Pages workflow expectations
  • remind contributors about tracking .nbconvert.last_run markers and include a docs-focused pre-PR checklist

Testing

  • not run

https://chatgpt.com/codex/tasks/task_e_69082a46b5c48326b8aae92a69837211

@codecov
Copy link

codecov bot commented Nov 3, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.23%. Comparing base (6a88cc8) to head (40798b6).
⚠️ Report is 2 commits behind head on main.
✅ All tests successful. No failed tests found.

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +24 to +32
## Environment Setup

The documentation toolchain is defined in `devtools/conda-envs/docs_env.yaml`. Create (or update) the environment before running any docs-specific tasks:

```bash
conda env create -f devtools/conda-envs/docs_env.yaml # first-time setup
conda env update -f devtools/conda-envs/docs_env.yaml # subsequent syncs
conda activate pyunitwizard-docs
```

Choose a reason for hiding this comment

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

P1 Badge Fix broken conda environment commands

The environment setup snippet uses conda env create -f devtools/conda-envs/docs_env.yaml and conda env update -f …, but the YAML file does not define an environment name. Running those commands raises CondaValueError: Key 'name' missing unless the user supplies a name or the helper scripts are used. The instructions should either pass -n <env> or point contributors to create_conda_env.py/update_conda_env.py so setup succeeds【F:docs/README.md†L24-L32】【F:devtools/conda-envs/docs_env.yaml†L1-L18】

Useful? React with 👍 / 👎.

@dprada dprada merged commit 407fe87 into main Nov 3, 2025
7 checks passed
@dprada dprada deleted the codex/update-readme.md-with-comprehensive-guide branch November 4, 2025 04:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant