Closed redeboer closed 3 months ago
This issue is best done before #60, so that we can have an ampform-dpd/
directory next to the existing ampform/
directory
@shenvitor, in Sphinx documents, you usually organise content with toctree
. I would try that first. Later on, we may try to organise with sphinx-external-toc
as well.
Suggested structure:
index.md # <-- main toctree
branching-fractions.md
LambdaKpi.md # <-- sub toctree, NEW
LambdaKpi/
ampform.ipynb
ampform-dpd.ipynb # next PR!
manual.ipynb
etapip.md # <-- sub toctree, originally reaction.md
etapip/
ampform.ipynb
manual.ipynb
index.md # <-- main toctree
branching-fractions.md
lambda-k-pi/
index.md # <-- sub toctree, NEW
ampform.ipynb
ampform-dpd.ipynb # next PR!
manual.ipynb
eta-pi-p/
index.md # <-- sub toctree, originally reaction.md
pgamma-state.ipynb
ampform.ipynb
manual.ipynb
index.md # <-- main toctree
branching-fractions.md
lambda-k-pi/
index.md # <-- sub toctree, NEW
automated.ipynb
eta-pi-p/
index.md # <-- sub toctree, originally reaction.md
pgamma-state.ipynb
automated.ipynb
manual.ipynb
And then in #60, we rename automated
to ampform
😁 Because then there are two 'automated' ways of building the amplitude model.
Btw, you can later on set redirects on your Read the Docs page (gluex-nstar.rtfd.io).
For the banner, see e.g. here: https://github.com/ComPWA/polarimetry/blob/83d1c3fb0b55ef27504cd1db700b9c09a0f22640/docs/conf.py#L292-L297
See here for inspiration.