QuantEcon / QuantEcon.py / 28912983847
94%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 156
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 93.561%. Remained the same
28912983847

push

github

web-flow 
DOC: Refresh contributing guide and fix stale docs build config (#850)

* DOC: Refresh contributing guide and fix stale docs build config

Partner to #836 (root CONTRIBUTING.md entrypoint) and addresses part of
#834 (review contributing/developer docs for completeness).

contributing.rst
- Correct an out-of-date claim: the PR docs preview is built by Read the
  Docs, not "one of the GitHub Actions" (there is no docs-building GHA
  workflow).
- Add the concrete commands the guide only described in prose: clone +
  `conda env create -f environment.yml`, an editable `flit install
  --symlink`, running tests (`pytest`) and style checks (the exact CI
  `flake8 --select=F401,F405,E231 quantecon`), and building the docs
  (`pip install -r docs/rtd-requirements.txt` then `make html`).
- Use https for the issue-tracker and Discourse links; strip trailing
  whitespace.

conf.py
- Remove the dead `import pip` / `mock` block. It used `pip.main()`
  (removed in pip 10) and produced a `MagicMock` that nothing uses (the
  MOCK_MODULES section below it is fully commented out) -- a latent
  build hazard for no benefit.
- Fix the `numydoc_show_class_members` typo (-> `numpydoc_`), which was
  silently ignored.
- Modernise the deprecated intersphinx mapping to the current form
  `{'python': ('https://docs.python.org/3', None)}`.

index.rst
- Add `optimize` to the intro prose (it was in the toctree but missing
  from the module description); strip a trailing-whitespace line.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* DOC: Point API reference at implementation modules, not deprecated shims

qe_apidoc.py globbed `../quantecon/[a-z0-9]*.py` for the base-level
"tools" pages, which matches the lowercase compatibility shims
(`arma.py`, `lqcontrol.py`, ...) and excludes the real implementation
modules (`_arma.py`, `_lqcontrol.py`, ...). The generated stubs
therefore ran `.. automodule::` against modules that are marked "not
meant for public use and... (continued)

8093 of 8650 relevant lines covered (93.56%)

0.94 hits per line

Jobs
ID Job ID Ran Files Coverage
1 28912983847.1 156
93.56
 GitHub Action Run
Source Files on build 28912983847