Code

Reorganize online documentation#3382

Code

Merged

mrmundt merged 179 commits intomainPyomo/pyomo:mainfrom

doc-reorgPyomo/pyomo:doc-reorgCopy head branch name to clipboard

Oct 30, 2024

Commits

Commits on Jun 4, 2024

• Archiving current state of OnlineDocs

  jsiirola

  committed
  c19f91d

  Copy full SHA for c19f91d

• Initial reorganization of Pyomo documentation (replicating 91e9f59 and 6e7cd39 by @blnicho)

  jsiirola

  committed
  85e1003

  Copy full SHA for 85e1003

• Update / clean up .gitignore

  jsiirola

  committed
  731b7e2

  Copy full SHA for 731b7e2

Commits on Jul 31, 2024

• Merge branch 'main' into doc-reorg

  blnicho

  committed
  7f7688e

  Copy full SHA for 7f7688e

• Porting recent changes in docs to equivalent sections in the doc-reorg branch

  blnicho

  committed
  e3992db

  Copy full SHA for e3992db

• Fixing typo

  blnicho

  authored
  a31f0ff

  Copy full SHA for a31f0ff

Commits on Aug 23, 2024

• Merge branch 'main' into doc-reorg

  blnicho

  committed
  d4726b1

  Copy full SHA for d4726b1

• Updating doc-reorg branch with recent doc changes from main

  blnicho

  committed
  8adfd3e

  Copy full SHA for 8adfd3e

• Reorganizing top-level TOC

  blnicho

  committed
  54fdf02

  Copy full SHA for 54fdf02

• Filling out index

  emma58

  committed
  8359d36

  Copy full SHA for 8359d36

• Playing with whitespace

  emma58

  committed
  520820b

  Copy full SHA for 520820b

• removing newlines in table

  emma58

  committed
  a7caa36

  Copy full SHA for a7caa36

• Learning how tables work in rst'

  emma58

  committed
  cc082e7

  Copy full SHA for cc082e7

• Link to future, removing duplicate related packages'

  emma58

  committed
  8ec5067

  Copy full SHA for 8ec5067

• wider table columns

  emma58

  committed
  d3baf28

  Copy full SHA for d3baf28

• renaming user_guides to user_explanations

  emma58

  committed
  d451596

  Copy full SHA for d451596

• Adding and organizing the user explanations directory

  emma58

  committed
  7a0a1ee

  Copy full SHA for 7a0a1ee

• resolve table formatting

  jsiirola

  committed
  ac48ed5

  Copy full SHA for ac48ed5

• Reorganizing docs

  blnicho

  committed
  7f18f37

  Copy full SHA for 7f18f37

• Merge branch 'doc-reorg' of https://github.com/Pyomo/pyomo into doc-reorg

  blnicho

  committed
  4fc015e

  Copy full SHA for 4fc015e

• Moving developer docs to developer utilities folder in user_explanations'

  emma58

  committed
  f35e4a5

  Copy full SHA for f35e4a5

• Merge branch 'doc-reorg' of github.com:Pyomo/pyomo into doc-reorg

  emma58

  committed
  fdbc66c

  Copy full SHA for fdbc66c

• Removing developer_guide folder

  emma58

  committed
  6a6b346

  Copy full SHA for 6a6b346

Commits on Aug 27, 2024

• Restore logic to generate SPY files

  jsiirola

  committed
  efc7560

  Copy full SHA for efc7560

• Update doc include paths to be relative to doc root

  jsiirola

  committed
  8206928

  Copy full SHA for 8206928

• NFC: fix doc indentation

  jsiirola

  committed
  001f1d0

  Copy full SHA for 001f1d0

• Update doc references

  jsiirola

  committed
  1d3d893

  Copy full SHA for 1d3d893

• Doc: fix autodoc import

  jsiirola

  committed
  584634e

  Copy full SHA for 584634e

• Re-add missing src directly dropped during reorg

  jsiirola

  committed
  497d82e

  Copy full SHA for 497d82e

• restore 'make clean' target

  jsiirola

  committed
  e2cb023

  Copy full SHA for e2cb023

• doc: add missing index.rst

  jsiirola

  committed
  d6b7005

  Copy full SHA for d6b7005

• Move errors.rst to not break links from code

  jsiirola

  committed
  9af47aa

  Copy full SHA for 9af47aa

• Simplifying directory names

  jsiirola

  committed
  25c6774

  Copy full SHA for 25c6774

• Reorganize getting-started / how-to

  Show description for 0a878e9
  jsiirola

  committed
  0a878e9

  Copy full SHA for 0a878e9

• Renaming some directories

  jsiirola

  committed
  679a625

  Copy full SHA for 679a625

• Moving some files around

  jsiirola

  committed
  63cf630

  Copy full SHA for 63cf630

• Reorganize explanations & reference

  jsiirola

  committed
  4453c29

  Copy full SHA for 4453c29

• Track move of kernel discussion

  jsiirola

  committed
  4e31974

  Copy full SHA for 4e31974

• Move kernel API docs

  jsiirola

  committed
  d45733b

  Copy full SHA for d45733b

• Fix link, improve page title

  jsiirola

  committed
  d0cef84

  Copy full SHA for d0cef84

• Improve diataxis table formatting

  jsiirola

  committed
  e5452d8

  Copy full SHA for e5452d8

• More style tweaks

  jsiirola

  committed
  a9a15ab

  Copy full SHA for a9a15ab

Commits on Aug 28, 2024

• Merge branch 'main' into doc-reorg

  jsiirola

  committed
  174f010

  Copy full SHA for 174f010

• reworking src to restore history

  jsiirola

  committed
  3564044

  Copy full SHA for 3564044

• Restoring src from Archive

  jsiirola

  committed
  5935756

  Copy full SHA for 5935756

• Doc: fixing typo

  jsiirola

  committed
  ea7a0fd

  Copy full SHA for ea7a0fd

• Add a make target to help with development

  jsiirola

  committed
  9bffc0a

  Copy full SHA for 9bffc0a

• Only raise DeferredImportError if we are not building docs

  jsiirola

  committed
  4d097b6

  Copy full SHA for 4d097b6

Commits on Aug 30, 2024

• Merge branch 'main' into doc-reorg

  jsiirola

  committed
  cb38acb

  Copy full SHA for cb38acb

• Move in_testing_environment, FlagType, NOTSET to common.flags

  jsiirola

  committed
  e97965f

  Copy full SHA for e97965f

• Standardize use of in_testing_environment(), building_documentation()

  jsiirola

  committed
  e6d7445

  Copy full SHA for e6d7445

• NFC: comments and black

  jsiirola

  committed
  b327c19

  Copy full SHA for b327c19

• Allow detecting documentation regardless of testing

  jsiirola

  committed
  bf9a569

  Copy full SHA for bf9a569

• NFC: typo

  jsiirola

  committed
  d1b5d5a

  Copy full SHA for d1b5d5a

• Update URL checker

  jsiirola

  committed
  7f73bb0

  Copy full SHA for 7f73bb0

• Update URL checker

  jsiirola

  committed
  3f18ce5

  Copy full SHA for 3f18ce5

• Rework RTD URL to work with the url checker

  jsiirola

  committed
  98c5510

  Copy full SHA for 98c5510

Commits on Aug 31, 2024

• Stub in the auto-generated library reference

  jsiirola

  committed
  fd3ad4f

  Copy full SHA for fd3ad4f

• Move the API docs to the root; rename old Library Reference -> Topical

  jsiirola

  committed
  8e4d410

  Copy full SHA for 8e4d410

Commits on Sep 13, 2024

• Merge branch 'main' into doc-reorg

  jsiirola

  committed
  fac094a

  Copy full SHA for fac094a

• Merge branch 'doc-reorg' into doc-index

  jsiirola

  committed
  5d1a3aa

  Copy full SHA for 5d1a3aa

Commits on Sep 16, 2024

• Add citation to balas.py

  Show description for 6cc0789
  viens-code

  authored
  6cc0789

  Copy full SHA for 6cc0789

• Add abs_opt_gap example to alternative_solutions documentation

  Show description for 80a6137
  viens-code

  authored
  80a6137

  Copy full SHA for 80a6137

• Update balas.py to fix black issue

  viens-code

  authored
  17d07a8

  Copy full SHA for 17d07a8

• Balas.py Black issue fix

  viens-code

  authored
  8a01aba

  Copy full SHA for 8a01aba

• Update balas.py to fix spelling error

  viens-code

  authored
  79de242

  Copy full SHA for 79de242

Commits on Sep 23, 2024

• Removing redundant pynumero, common API documentation

  jsiirola

  committed
  add2bef

  Copy full SHA for add2bef

• Update rst docs to not duplicate API docs (add :noindex: or use summary only)

  jsiirola

  committed
  169d7ec

  Copy full SHA for 169d7ec

Commits on Sep 30, 2024

• Simplify toctree entries in library reference

  jsiirola

  committed
  a166b5a

  Copy full SHA for a166b5a

Commits on Oct 1, 2024

• make clean: remove autogenerated API files

  jsiirola

  committed
  6a4730e

  Copy full SHA for 6a4730e

• Update references to BiBTeX 'alpha' format

  jsiirola

  committed
  b099501

  Copy full SHA for b099501

• Update __init__.py to remove absolute pyomo imports

  jsiirola

  committed
  c8f5333

  Copy full SHA for c8f5333

• General cleanup of doc files

  jsiirola

  committed
  baee0e9

  Copy full SHA for baee0e9

• re-adding working with abstrct models sections [inadvertantly removed]

  jsiirola

  committed
  865a55e

  Copy full SHA for 865a55e

• Fix incorrect class references

  jsiirola

  committed
  0bdc03a

  Copy full SHA for 0bdc03a

• Remove autosectionlabel, update references

  jsiirola

  committed
  3152c31

  Copy full SHA for 3152c31

• General update of documentation formatting

  jsiirola

  committed
  2354765

  Copy full SHA for 2354765

• Clean up docstrings, silence Sphinx warnings and errors

  jsiirola

  committed
  38375e7

  Copy full SHA for 38375e7

• Switch to using ply decorators to not confuse Sphinx

  jsiirola

  committed
  8dc93cb

  Copy full SHA for 8dc93cb

Commits on Oct 3, 2024

• Rework building_documentation() logic to improve Sphinx output/suppress warnings

  jsiirola

  committed
  5530607

  Copy full SHA for 5530607

• Avoid importing Qt when building documentation to suppress Sphine API autodoc warnings

  jsiirola

  committed
  6297b95

  Copy full SHA for 6297b95

• Update the deprecation decorators to avoid doc warnings

  Show description for 29687a8
  jsiirola

  committed
  29687a8

  Copy full SHA for 29687a8

• Wrap enum.IntEnum to resolve warnings from Sphinx autodoc

  jsiirola

  committed
  2f280c2

  Copy full SHA for 2f280c2

• Clean up some imports

  jsiirola

  committed
  5df7203

  Copy full SHA for 5df7203

• Output str instead of repr for Config default values

  jsiirola

  committed
  f08ebad

  Copy full SHA for f08ebad

• Add blank line to help resolve Sphinx autodoc warnings

  jsiirola

  committed
  f8c99c4

  Copy full SHA for f8c99c4

• Update TestCase documentation & resolve some Sphinx warnings

  jsiirola

  committed
  03cb961

  Copy full SHA for 03cb961

• Suppress warning for (intentionally) unindexed RST file

  jsiirola

  committed
  ff40d0d

  Copy full SHA for ff40d0d

• Remove unused intersphinx link

  jsiirola

  committed
  b6767f7

  Copy full SHA for b6767f7

• Update copyright statement to match the rest of Pyomo

  jsiirola

  committed
  823f556

  Copy full SHA for 823f556

• Update Sphinx config to improve API rendering

  jsiirola

  committed
  56095e9

  Copy full SHA for 56095e9

• Fixing typos

  jsiirola

  committed
  11f0df4

  Copy full SHA for 11f0df4

• Deprecate/Remove unneeded references to results data structures from __init__.py

  jsiirola

  committed
  76c4250

  Copy full SHA for 76c4250

Commits on Oct 4, 2024

• Merge branch 'main' into doc-reorg

  jsiirola

  committed
  f093e88

  Copy full SHA for f093e88

• Merge branch 'doc-reorg' into doc-index

  jsiirola

  committed
  cdf6396

  Copy full SHA for cdf6396

• Update EOL handling in ConfigDict to remove extra EOL, update tests

  jsiirola

  committed
  cffc600

  Copy full SHA for cffc600

• Track changes in repr(FlagType)

  jsiirola

  committed
  a08fa45

  Copy full SHA for a08fa45

• NFC: apply black

  jsiirola

  committed
  19cfd2d

  Copy full SHA for 19cfd2d

Commits on Oct 7, 2024

• Import relevant module for doctests of classes/functions

  jsiirola

  committed
  47b0ff4

  Copy full SHA for 47b0ff4

• Don't document inherited-members for ndarray derived classes

  jsiirola

  committed
  4b74321

  Copy full SHA for 4b74321

• Exclude all 'tests' when building source documentation

  jsiirola

  committed
  5cce82c

  Copy full SHA for 5cce82c

• Allow interior_point ex1.py to be imported without executing

  jsiirola

  committed
  18c0f82

  Copy full SHA for 18c0f82

• Remove unused import

  jsiirola

  committed
  a385f42

  Copy full SHA for a385f42

• Fix doc example typo

  jsiirola

  committed
  a4e39b1

  Copy full SHA for a4e39b1

Commits on Oct 8, 2024

• Improve the error message from ImmutableConfigValue

  jsiirola

  committed
  1729143

  Copy full SHA for 1729143

• Add support for setting the state of `building_documentation()`

  jsiirola

  committed
  1e09883

  Copy full SHA for 1e09883

• Check state of `logger` module attribute before dereferencing

  Show description for e832bf1
  jsiirola

  committed
  e832bf1

  Copy full SHA for e832bf1

• Resolve errors in docstrings

  jsiirola

  committed
  777f868

  Copy full SHA for 777f868

• Use try-finally pattern in the context manager (from decorator documentation)

  jsiirola

  committed
  efcaac7

  Copy full SHA for efcaac7

• Emit log messages to Pyomo logger when building documentation

  Show description for f827af6
  jsiirola

  committed
  f827af6

  Copy full SHA for f827af6

• Update sphinx configuration

  jsiirola

  committed
  2777b48

  Copy full SHA for 2777b48

• Clean up Reference TOC appearance

  jsiirola

  committed
  6c3150f

  Copy full SHA for 6c3150f

• Fix docstring error

  jsiirola

  committed
  7fb6690

  Copy full SHA for 7fb6690

• Simplify logic for erstoring log handlers

  jsiirola

  committed
  19e18ac

  Copy full SHA for 19e18ac

• Remove unused sphinx extensions

  jsiirola

  committed
  87e6b21

  Copy full SHA for 87e6b21

• Fixing doc typos

  jsiirola

  committed
  2536333

  Copy full SHA for 2536333

• Remove use of relative imports

  jsiirola

  committed
  03e14c4

  Copy full SHA for 03e14c4

• NFC: apply black

  jsiirola

  committed
  2c87f43

  Copy full SHA for 2c87f43

• Merge branch 'main' into doc-reorg

  jsiirola

  committed
  e6ecf55

  Copy full SHA for e6ecf55

• Merge branch 'doc-reorg' into doc-index

  jsiirola

  committed
  180602f

  Copy full SHA for 180602f

• Standardizing references

  jsiirola

  committed
  f309eed

  Copy full SHA for f309eed

• Documenting reference standard

  jsiirola

  committed
  d91ab37

  Copy full SHA for d91ab37

• Updating reference

  jsiirola

  committed
  bfad2dd

  Copy full SHA for bfad2dd

• remove references to the global logger

  jsiirola

  committed
  d1df0ef

  Copy full SHA for d1df0ef

• Fix 'tests' exclusion pattern

  jsiirola

  committed
  ee1e3d5

  Copy full SHA for ee1e3d5

Commits on Oct 9, 2024

• Explicitly set the default numpy print precision

  jsiirola

  committed
  7afbc41

  Copy full SHA for 7afbc41

• Update doctest test file exclusion

  jsiirola

  committed
  a7da074

  Copy full SHA for a7da074

Commits on Oct 10, 2024

• Update tests filter for Sphinx>=8

  jsiirola

  committed
  c38b48b

  Copy full SHA for c38b48b

• Minor (NFC) reorder of doctest_global_setup

  jsiirola

  committed
  38a4b3e

  Copy full SHA for 38a4b3e

• Make TempfileContext more robust when deleted during Python shutdown

  jsiirola

  committed
  97e23a1

  Copy full SHA for 97e23a1

• Resolve Sphinx errors; update comment to match current practice

  jsiirola

  committed
  532115c

  Copy full SHA for 532115c

• Edit MIS test to not run on module import

  jsiirola

  committed
  ad32818

  Copy full SHA for ad32818

• Silence Sphinx warnings

  jsiirola

  committed
  07b5cbe

  Copy full SHA for 07b5cbe

• NFC: typo

  jsiirola

  committed
  562c5d5

  Copy full SHA for 562c5d5

• Move pint import to common.dependencies; update for Python 3.13 + pint<=0.24.3

  jsiirola

  committed
  1dd0a35

  Copy full SHA for 1dd0a35

• Revert previous commit to Archive/conf.py; apply to current OnlineDocs/conf.py

  jsiirola

  committed
  b47c26c

  Copy full SHA for b47c26c

• Do not trigger DeferredImportError exceptions when attempting to serialize objects

  jsiirola

  committed
  08341a9

  Copy full SHA for 08341a9

• Update doctests for OSX, Numpy changes

  jsiirola

  committed
  48080ad

  Copy full SHA for 48080ad

• Remove debugging

  jsiirola

  committed
  eefb98c

  Copy full SHA for eefb98c

• Add (hidden) documentation of the NumPy2 output

  jsiirola

  committed
  465298a

  Copy full SHA for 465298a

Commits on Oct 11, 2024

• Fix indentation typo

  jsiirola

  committed
  1860a1d

  Copy full SHA for 1860a1d

• Clean up makefile

  jsiirola

  committed
  91922d7

  Copy full SHA for 91922d7

• Restore (and update) doc README

  jsiirola

  committed
  adf8bb5

  Copy full SHA for adf8bb5

• update baseline to match python 3.13 behavior

  jsiirola

  committed
  c29de6b

  Copy full SHA for c29de6b

• Merge pull request #3378 from jsiirola/doc-index

  Show description for c157587
  jsiirola

  authored
  c157587

  Copy full SHA for c157587

• Remove doc/Archive directory

  jsiirola

  committed
  8830cc7

  Copy full SHA for 8830cc7

• Update readme with relevant hashes

  jsiirola

  committed
  48c25ad

  Copy full SHA for 48c25ad

• Update readme with relevant hashes; reformet

  jsiirola

  committed
  4fb1eba

  Copy full SHA for 4fb1eba

• simplify makefile

  jsiirola

  committed
  6580615

  Copy full SHA for 6580615

• Merge remote-tracking branch 'refs/remotes/origin/doc-reorg' into doc-reorg

  jsiirola

  committed
  4ece0a2

  Copy full SHA for 4ece0a2

• NFC: fix typos

  jsiirola

  committed
  9969a77

  Copy full SHA for 9969a77

• Merge branch 'doc-reorg' into viens-main

  jsiirola

  committed
  666a3c2

  Copy full SHA for 666a3c2

• Fixing formatting

  jsiirola

  committed
  9a4a0d4

  Copy full SHA for 9a4a0d4

• Remove debugging

  jsiirola

  committed
  624ac11

  Copy full SHA for 624ac11

• Resolve typos

  jsiirola

  committed
  0ebb9b3

  Copy full SHA for 0ebb9b3

• Consolidate references

  jsiirola

  committed
  d8e9ef5

  Copy full SHA for d8e9ef5

• Standardize references

  jsiirola

  committed
  796c0ea

  Copy full SHA for 796c0ea

• Merge branch 'main' into doc-reorg

  jsiirola

  committed
  8ffb03b

  Copy full SHA for 8ffb03b

• Show solutions in example

  jsiirola

  committed
  b205462

  Copy full SHA for b205462

• Expand initial introduction (slightly)

  jsiirola

  committed
  97aaa71

  Copy full SHA for 97aaa71

• Defer the pytest import

  jsiirola

  committed
  0e148dd

  Copy full SHA for 0e148dd

• Move tests into a /tests/ directory

  jsiirola

  committed
  a7ddf63

  Copy full SHA for a7ddf63

Commits on Oct 12, 2024

• bugfix: pytest import

  jsiirola

  committed
  f3a9b1f

  Copy full SHA for f3a9b1f

• Move kernel examples into OnlineDocs/src

  jsiirola

  committed
  28a365d

  Copy full SHA for 28a365d

• Update ptah to GDP examples

  jsiirola

  committed
  68e7056

  Copy full SHA for 68e7056

Commits on Oct 14, 2024

• Remove call to show() from visualize_model_graph()

  jsiirola

  committed
  690222c

  Copy full SHA for 690222c

• Ensure in_testing_environment and matplottlib are resolved earlier in doctest

  jsiirola

  committed
  f2827f1

  Copy full SHA for f2827f1

• Merge branch 'doc-reorg' into main

  jsiirola

  authored
  6eb273b

  Copy full SHA for 6eb273b

Commits on Oct 15, 2024

• Merge branch 'main' into doc-reorg

  jsiirola

  authored
  4e6ebbe

  Copy full SHA for 4e6ebbe

• Fixing typo in alternative_solutions.rst

  blnicho

  authored
  43075cb

  Copy full SHA for 43075cb

• Merge pull request #3370 from viens-code/main

  Show description for 5293720
  blnicho

  authored
  5293720

  Copy full SHA for 5293720

• NFC: fix doc typo

  jsiirola

  committed
  c9d164b

  Copy full SHA for c9d164b

Commits on Oct 22, 2024

• Restoring old PyROS solve() documentation

  jsiirola

  committed
  4c93a88

  Copy full SHA for 4c93a88

• Fix doc typo

  jsiirola

  committed
  71084dc

  Copy full SHA for 71084dc

• Shorten uncertainty set class names in summary

  jsiirola

  committed
  427b8ba

  Copy full SHA for 427b8ba

• Update doc text to not run afoul of Sphinx short description logic

  jsiirola

  committed
  79a1134

  Copy full SHA for 79a1134

Commits on Oct 28, 2024

• Merge branch 'main' into doc-reorg

  jsiirola

  authored
  ff8e473

  Copy full SHA for ff8e473

Commits on Oct 29, 2024

• Merge branch 'main' into doc-reorg

  jsiirola

  authored
  0e7cdd2

  Copy full SHA for 0e7cdd2

Commits on Oct 30, 2024

• Addressing review comments

  jsiirola

  committed
  272497d

  Copy full SHA for 272497d