Code

Automatic documentation#130

Code

Merged

jlenain merged 103 commits intocta-observatory:maincta-observatory/nectarchain:mainfrom jlenain:docsjlenain/nectarchain:docsCopy head branch name to clipboardJul 29, 2024

+457-67

Commits

Commits on Jul 26, 2024

• Follow template from repository https://github.com/cta-observatory/project-template-python-pure

  jlenain

  committed
  fa02674

  Copy full SHA for fa02674

• Follow template from repository https://github.com/cta-observatory/project-template-python-pure

  jlenain

  committed
  2fbdee5

  Copy full SHA for 2fbdee5

• Try to implement first auto-generated doc with Sphinx

  jlenain

  committed
  9e0f27b

  Copy full SHA for 9e0f27b

• Accept PNG for logo in doc

  jlenain

  committed
  6703e1c

  Copy full SHA for 6703e1c

• NectarCAM logo

  jlenain

  committed
  da03c73

  Copy full SHA for da03c73

• Try to make Sphinx work with theme pydata-sphinx-theme

  jlenain

  committed
  138bbac

  Copy full SHA for 138bbac

• Try to deploy GitHub pages n CI

  jlenain

  committed
  866abf0

  Copy full SHA for 866abf0

• Try to deploy GitHub pages in CI

  jlenain

  committed
  1b64b96

  Copy full SHA for 1b64b96

• Fix python version for docs in CI

  jlenain

  committed
  0f9a6cc

  Copy full SHA for 0f9a6cc

• git describe fails on CI

  jlenain

  committed
  126c8ae

  Copy full SHA for 126c8ae

• Fix docs path in CI

  jlenain

  committed
  6f83c8b

  Copy full SHA for 6f83c8b

• Fix docs path in CI

  jlenain

  committed
  b3c987f

  Copy full SHA for b3c987f

• Fix docs path in CI

  jlenain

  committed
  0435f73

  Copy full SHA for 0435f73

• Enable git tag in CI

  jlenain

  committed
  11927e3

  Copy full SHA for 11927e3

• Disable git tag in CI

  jlenain

  committed
  d26e998

  Copy full SHA for d26e998

• Try to include all imported sub-modules in API doc.

  jlenain

  committed
  96eddd3

  Copy full SHA for 96eddd3

• Try doc with sphinx-automodapi

  jlenain

  committed
  4a74558

  Copy full SHA for 4a74558

• Add sphinx-automodapi as dependency

  jlenain

  committed
  8f6bfb8

  Copy full SHA for 8f6bfb8

• Try doc with sphinx-automodapi

  jlenain

  committed
  d9095c4

  Copy full SHA for d9095c4

• Try doc with sphinx-automodapi

  jlenain

  committed
  cd77540

  Copy full SHA for cd77540

• Try doc with autosummary

  jlenain

  committed
  3fa5432

  Copy full SHA for 3fa5432

• Try doc piece by piece

  jlenain

  committed
  307dee1

  Copy full SHA for 307dee1

• Disable autosummary in doc

  jlenain

  committed
  f26294b

  Copy full SHA for f26294b

• Try doc again

  jlenain

  committed
  9534d6a

  Copy full SHA for 9534d6a

• Try doc with autosummary

  jlenain

  committed
  c7945fd

  Copy full SHA for c7945fd

• Try doc with autosummary

  jlenain

  committed
  d97e37d

  Copy full SHA for d97e37d

• Try doc with sphinx-autoapi

  jlenain

  committed
  9512fca

  Copy full SHA for 9512fca

• Revert "Try doc with autosummary"

  Show description for 78d2773
  jlenain

  committed
  78d2773

  Copy full SHA for 78d2773

• Revert "Try doc with sphinx-autoapi"

  Show description for 678108f
  jlenain

  committed
  678108f

  Copy full SHA for 678108f

• Simplify doc conf

  jlenain

  committed
  7f0edcb

  Copy full SHA for 7f0edcb

• Back to pydata sphinx theme

  jlenain

  committed
  e8c6463

  Copy full SHA for e8c6463

• The alabaster theme works for the doc!

  jlenain

  committed
  a7ede95

  Copy full SHA for a7ede95

• Revert "The alabaster theme works for the doc!"

  Show description for 771cb64
  jlenain

  committed
  771cb64

  Copy full SHA for 771cb64

• Revert "Back to pydata sphinx theme"

  Show description for 15f5811
  jlenain

  committed
  15f5811

  Copy full SHA for 15f5811

• Revert "Simplify doc conf"

  Show description for 9cbc1d1
  jlenain

  committed
  9cbc1d1

  Copy full SHA for 9cbc1d1

• Revert "Revert "Try doc with sphinx-autoapi""

  Show description for db10e7b
  jlenain

  committed
  db10e7b

  Copy full SHA for db10e7b

• Revert "Revert "Try doc with autosummary""

  Show description for 921fe0a
  jlenain

  committed
  921fe0a

  Copy full SHA for 921fe0a

• Revert "Try doc with sphinx-autoapi"

  Show description for da4c3b8
  jlenain

  committed
  da4c3b8

  Copy full SHA for da4c3b8

• Revert "Try doc with autosummary"

  Show description for 00d2f60
  jlenain

  committed
  00d2f60

  Copy full SHA for 00d2f60

• Revert "Try doc with autosummary"

  Show description for 65f2497
  jlenain

  committed
  65f2497

  Copy full SHA for 65f2497

• Revert "Try doc again"

  Show description for 53359ab
  jlenain

  committed
  53359ab

  Copy full SHA for 53359ab

• Revert "Disable autosummary in doc"

  Show description for eb7f7aa
  jlenain

  committed
  eb7f7aa

  Copy full SHA for eb7f7aa

• Revert "Try doc piece by piece"

  Show description for 76b3d48
  jlenain

  committed
  76b3d48

  Copy full SHA for 76b3d48

• Revert "Try doc with autosummary"

  Show description for cced1f5
  jlenain

  committed
  cced1f5

  Copy full SHA for cced1f5

• Revert "Try doc with sphinx-automodapi"

  Show description for 8450eac
  jlenain

  committed
  8450eac

  Copy full SHA for 8450eac

• Revert "Try doc with sphinx-automodapi"

  Show description for df647e8
  jlenain

  committed
  df647e8

  Copy full SHA for df647e8

• Revert "Add sphinx-automodapi as dependency"

  Show description for 1cd7739
  jlenain

  committed
  1cd7739

  Copy full SHA for 1cd7739

• Revert "Try doc with sphinx-automodapi"

  Show description for 8501f14
  jlenain

  committed
  8501f14

  Copy full SHA for 8501f14

• Re-structure API documentation, using automodapi

  jlenain

  committed
  5db5392

  Copy full SHA for 5db5392

• Fix docstrings

  jlenain

  committed
  c8699b9

  Copy full SHA for c8699b9

• Blank line missing in doc for Sphinx & pre-commit hooks

  jlenain

  committed
  5fb9cbd

  Copy full SHA for 5fb9cbd

• Alabaster theme

  jlenain

  committed
  6275c3e

  Copy full SHA for 6275c3e

• Add more doc

  jlenain

  committed
  fc9ef65

  Copy full SHA for fc9ef65

• Work on Sphinx configuration.

  jlenain

  committed
  572a05d

  Copy full SHA for 572a05d

• Add configuration for Read the Docs.

  jlenain

  committed
  8ea3052

  Copy full SHA for 8ea3052

• Avoid building all branches on push

  jlenain

  committed
  ec26a19

  Copy full SHA for ec26a19

• Only deploy github-pages (if we want to) on push in main branch

  jlenain

  committed
  863e289

  Copy full SHA for 863e289

• Remove Read the Docs configuration, to deploy doc as GitHub pages only.

  jlenain

  committed
  6e04db0

  Copy full SHA for 6e04db0

• Add more auto-docs for some submodules.

  jlenain

  committed
  bb856cd

  Copy full SHA for bb856cd

• Lint code

  jlenain

  committed
  3bb8290

  Copy full SHA for 3bb8290

• Restore chargesComponent.py from main

  jlenain

  committed
  594d564

  Copy full SHA for 594d564

• Merge branch 'main' into docs

  jlenain

  authored
  48cc819

  Copy full SHA for 48cc819

• Try to solve errors for docs in CI

  jlenain

  committed
  3cc84df

  Copy full SHA for 3cc84df

• Try to solve errors for docs in CI

  jlenain

  committed
  d2fee77

  Copy full SHA for d2fee77

• Fix typo

  jlenain

  committed
  1436e11

  Copy full SHA for 1436e11

• Try to fix errors in docs in CI

  jlenain

  committed
  09d35a1

  Copy full SHA for 09d35a1

• Try to fix errors in docs in CI

  jlenain

  committed
  ec0529f

  Copy full SHA for ec0529f

• Test excluding components from doc

  jlenain

  committed
  44ba50a

  Copy full SHA for 44ba50a

• Try fixing doc for makers submodule

  jlenain

  committed
  a9edff8

  Copy full SHA for a9edff8

• Try fixing doc for makers submodule

  jlenain

  committed
  9e318f2

  Copy full SHA for 9e318f2

• Try fixing doc for makers submodule

  jlenain

  committed
  c700901

  Copy full SHA for c700901

• Try fixing doc for makers submodule

  jlenain

  committed
  095ce4c

  Copy full SHA for 095ce4c

Commits on Jul 29, 2024

• Fix clean in Makefile

  jlenain

  committed
  09d40dd

  Copy full SHA for 09d40dd

• Try to deploy with alabaster theme.

  jlenain

  committed
  af399e7

  Copy full SHA for af399e7

• Force a doc CI run in ultra-verbose mode, to understand why the docs are not properly built in CI.

  jlenain

  committed
  f0c8f35

  Copy full SHA for f0c8f35

• Makefile for Sphinx back to initial state

  jlenain

  committed
  768a43a

  Copy full SHA for 768a43a

• Force a doc CI run in ultra-verbose mode

  jlenain

  committed
  7fe2b78

  Copy full SHA for 7fe2b78

• Force a doc CI run in verbose mode

  jlenain

  committed
  73fc756

  Copy full SHA for 73fc756

• Do not explicitly pass options to sphinx in CI, but rely on docs Makefile itself.

  jlenain

  committed
  c33a5b6

  Copy full SHA for c33a5b6

• Only use automodule with Sphinx

  jlenain

  committed
  49a3cf2

  Copy full SHA for 49a3cf2

• Fix typo in docstring.

  jlenain

  committed
  f8c4e37

  Copy full SHA for f8c4e37

• Use Sphinx nitpick_ignore

  jlenain

  committed
  0b7a9fc

  Copy full SHA for 0b7a9fc

• Force a test deployment of github-pages

  jlenain

  committed
  bc09633

  Copy full SHA for bc09633

• Fix typo and force a test deployment of github-pages

  jlenain

  committed
  a8e9d69

  Copy full SHA for a8e9d69

• Deploy doc using token

  jlenain

  committed
  694d9a9

  Copy full SHA for 694d9a9

• Add write permission to docs CI

  jlenain

  committed
  1240779

  Copy full SHA for 1240779

• Changed syntax for arguments to github-pages-deploy GitHub action.

  jlenain

  committed
  3164e4a

  Copy full SHA for 3164e4a

• Changed syntax for arguments to github-pages-deploy GitHub action.

  jlenain

  committed
  6e9eb96

  Copy full SHA for 6e9eb96

• Play with github-pages-deploy GitHub action

  jlenain

  committed
  d05f074

  Copy full SHA for d05f074

• Force doc deployment

  jlenain

  committed
  e514f52

  Copy full SHA for e514f52

• Only deploy doc on PR on main branch

  jlenain

  committed
  c5cdb09

  Copy full SHA for c5cdb09

• Force test deployment of doc

  jlenain

  committed
  a069bb6

  Copy full SHA for a069bb6

• Force test deployment of doc

  jlenain

  committed
  efb68f7

  Copy full SHA for efb68f7

• Force test deployment of doc

  jlenain

  committed
  0614457

  Copy full SHA for 0614457

• Force test deployment of doc

  jlenain

  committed
  a5d5a99

  Copy full SHA for a5d5a99

• Force test deployment of doc

  jlenain

  committed
  08f5e6a

  Copy full SHA for 08f5e6a

• Force test deployment of doc

  jlenain

  committed
  5b67bd0

  Copy full SHA for 5b67bd0

• Force test deployment of doc

  jlenain

  committed
  bdbb73a

  Copy full SHA for bdbb73a

• Force version of github-pages-deploy action to last one.

  jlenain

  committed
  5622a53

  Copy full SHA for 5622a53

• Test forcing doc deployment

  jlenain

  committed
  0d6ea89

  Copy full SHA for 0d6ea89

• Deploy doc on Read the Docs instead of GitHub pages

  jlenain

  committed
  39fd0ec

  Copy full SHA for 39fd0ec

• Change doc target recipe to docs, needed, apparently, to deploy on Read the Docs.

  jlenain

  committed
  94fda9b

  Copy full SHA for 94fda9b

• Add a skeleton for a developer guide.

  jlenain

  committed
  2b7d811

  Copy full SHA for 2b7d811