Code

Rework documentation generation#869

Code

Merged

bpkroth merged 105 commits intomicrosoft:mainmicrosoft/MLOS:mainfrom bpkroth:doc-fixupsbpkroth/MLOS:doc-fixupsCopy head branch name to clipboardNov 15, 2024

+1,768-721

Commits

Commits on Oct 8, 2024

• black, pylint

  bpkroth

  committed
  e8401b6

• enforce warnings

  bpkroth

  committed
  7a24ab1

• address warning

  bpkroth

  committed
  5d4a460

• don't mess with vscode

  bpkroth

  committed
  cd70c97

Commits on Oct 9, 2024

• confs

  bpkroth

  committed
  6dd5aff

• remove some uses of autosummary for now

  bpkroth

  committed
  4769ee6

• Add args to sphinx-build by default

  bpkroth

  committed
  a5cb303

• Switch to autoapi

  bpkroth

  committed
  555d0f6

• remove use of sphinx-apidoc

  bpkroth

  committed
  f01fd6d

• fixup checks

  bpkroth

  committed
  38174a7

• make run include the usage text dynamically

  bpkroth

  committed
  e4cd2a6

• Revert "make run include the usage text dynamically"

  Show description for 00d074d
  bpkroth

  committed
  00d074d

Commits on Oct 14, 2024

• Merge branch 'main' into doc-fixups

  bpkroth

  committed
  4a16c2f

Commits on Oct 15, 2024

• Merge branch 'main' into doc-fixups

  bpkroth

  authored
  eea15ef

Commits on Oct 18, 2024

• restore overview prior to editing

  bpkroth

  committed
  da7a9ff

• Makefile improvements

  bpkroth

  committed
  102d169

• Work towards overview improvement

  bpkroth

  committed
  303dc27

• wip

  bpkroth

  committed
  16e0b55

Commits on Oct 31, 2024

• Merge branch 'main' into doc-fixups

  bpkroth

  committed
  6a10987

Commits on Nov 5, 2024

• Merge branch 'main' into doc-fixups

  bpkroth

  authored
  3bbdd1b

Commits on Nov 7, 2024

• wip: adding cross referencing links within the docstrings

  bpkroth

  committed
  76e5379

• fixups and make it more nitpicky about references

  bpkroth

  committed
  e165c15

Commits on Nov 8, 2024

• more doc cross reference fixups

  bpkroth

  committed
  40f1f68

• tweaks

  bpkroth

  committed
  fa92704

Commits on Nov 11, 2024

• adjustments for more type lookups

  bpkroth

  committed
  ae97da5

• Tweaks

  bpkroth

  committed
  e29366b

• fixups

  bpkroth

  committed
  8609e45

• Rewrite documentation on documentation

  bpkroth

  committed
  22c7f1b

• references in the doc testing

  bpkroth

  committed
  573b68f

• Remove overview rst and add mlos_bench run usage

  bpkroth

  committed
  26ef02e

• Remove some old error ignores

  bpkroth

  committed
  668a08e

• Those were redundant

  bpkroth

  committed
  36fdbaa

• Start running doctests

  bpkroth

  committed
  9304499

• fixups

  bpkroth

  committed
  56d440e

• start converting to napolean for numpy parsing

  bpkroth

  committed
  02478d4

• add more docstrings

  bpkroth

  committed
  c4c504b

• fixups

  bpkroth

  committed
  7e3c771

• fixups

  bpkroth

  committed
  af53e68

• Docstring fixups

  bpkroth

  committed
  f2e6aa7

Commits on Nov 12, 2024

• Makefile improvements and remove unnecessary templates

  bpkroth

  committed
  5eb79ac

• use improvements to intersphinx registry

  bpkroth

  committed
  2ca9caf

• remove old modules and tweaks to theme

  bpkroth

  committed
  d5476e9

• remove old things and cleanup confs

  bpkroth

  committed
  625cf2b

• napolean tweaks

  bpkroth

  committed
  202dcc6

• use correct source for Literal

  bpkroth

  committed
  96b96e9

• cleanup

  bpkroth

  committed
  7f1d160

• cleanup

  bpkroth

  committed
  07f32a5

• improve docs

  bpkroth

  committed
  8bef4f2

• tweaks

  bpkroth

  committed
  7cc7297

• improve docs

  bpkroth

  committed
  aebea53

• improvements to docs

  bpkroth

  committed
  447116a

• fixup

  bpkroth

  committed
  f034afa

• improvements

  bpkroth

  committed
  496162f

• more docs

  bpkroth

  committed
  6a86421

• tweaks

  bpkroth

  committed
  c46cdd4

• moar docs!

  bpkroth

  committed
  0c3e7ce

• unnecessary

  bpkroth

  committed
  7721b9c

• more docs

  bpkroth

  committed
  ba4fe09

• reformat docstrings

  bpkroth

  committed
  50075a8

• formatting

  bpkroth

  committed
  2b14658

• formatting

  bpkroth

  committed
  57cf01e

• comments

  bpkroth

  committed
  e644180

• more docs

  bpkroth

  committed
  838e2f1

• more docs

  bpkroth

  committed
  62a00a5

• more docs

  bpkroth

  committed
  9f10f62

• formatting

  bpkroth

  committed
  89ef731

• don't run anything via pytest parsing

  bpkroth

  committed
  09f1850

Commits on Nov 13, 2024

• ignore generated files

  bpkroth

  committed
  0625a18

• add a somehow missing test case

  bpkroth

  committed
  5ada076

• tweak

  bpkroth

  committed
  b3c2536

• fixup for keeping files based on github actions

  bpkroth

  committed
  8088719

• revert pylint tweak

  bpkroth

  committed
  b40ba84

• ignore some generated files to let vscode enumerate things quicker

  bpkroth

  committed
  3dcd0be

• always upload the artifact (for testing)

  bpkroth

  committed
  424f1fc

• Some mlos_bench examples

  bpkroth

  committed
  9810161

• more docs

  bpkroth

  committed
  c9e43a9

• hack to resolve internal typevars

  bpkroth

  committed
  44d3874

• fixup

  bpkroth

  committed
  7acd53a

• comments

  bpkroth

  committed
  8aa72a8

Commits on Nov 14, 2024

• more rules on how to schema interpret some things

  bpkroth

  committed
  be9b138

• docs on docs

  bpkroth

  committed
  920c333

• more docs

  bpkroth

  committed
  943cb27

• some more docs about environments

  bpkroth

  committed
  df08c2e

• reformat

  bpkroth

  committed
  fc92372

• docformatting

  bpkroth

  committed
  673b64f

• add some documentation todos

  bpkroth

  committed
  5b6f28b

• doc formatter

  bpkroth

  committed
  e28e4e2

• more docs

  bpkroth

  committed
  1156858

• more docs

  bpkroth

  committed
  26da3ed

• Merge remote-tracking branch 'upstream/main' into doc-fixups

  bpkroth

  committed
  8f5829d

• more docs

  bpkroth

  committed
  a5d5676

• Apply suggestions from code review

  Show description for ef43373
  

  bpkroth

  and

  motus

  authored
  ef43373

• more docs

  bpkroth

  committed
  4664abb

Commits on Nov 15, 2024

• formatting

  bpkroth

  committed
  3afe995

• rework

  bpkroth

  committed
  9725ad7

• docstyle

  bpkroth

  committed
  b24cb21

• raw format string

  bpkroth

  committed
  743af9c

• use a single long line for platform compatibility (windows doesn't like backslashes for command line continuation)

  bpkroth

  committed
  4965947

• note the extension

  bpkroth

  committed
  2646ccd

• Adding more docs about storage

  bpkroth

  committed
  18ff25c

• formatting

  bpkroth

  committed
  15499c3

• todo comments

  bpkroth

  committed
  e0c2955

• more docstrings and formatting

  bpkroth

  committed
  3f89042

• fixup

  bpkroth

  committed
  634a471

• Add some high level references for user access of data

  bpkroth

  committed
  5782c5a