V1 api docs

[sbch22]

Which issue(s) are closed by this pull request?

API references adjusted for v_1.0.0

Changes proposed in this pull request:

• removed pyrite.rst from docs/modules/
• added missing dip.rst, etc.rst, parameters.rst & parametric.rst to docs/modules

[hoyer-a]

Generally looking good!
In the other packages, the module page titles are like their import paths (e.g., pyrato.dsp). That's also what appears in the left sidebar.

Maybe change it for consistency, also for analytic.

[ahms5]

thank you for taking care. I would add to the comments from @hoyer-a please make sure that the doc is building without any warnings.

[sbch22]

The structure is adjusted for analytic submodule. All warnings from the compilation are taken care of. Only two from the example code reside but I will take care of those another day.

[f-brinkmann]

The structure is adjusted for analytic submodule. All warnings from the compilation are taken care of. Only two from the example code reside but I will take care of those another day.

Are they coming from code that you touched? If inot, it should be fixed in a different pull. We try to be strict about that to make the pulls smaller, and easier to review.

[sbch22]

The structure is adjusted for analytic submodule. All warnings from the compilation are taken care of. Only two from the example code reside but I will take care of those another day.

Are they coming from code that you touched? If inot, it should be fixed in a different pull. We try to be strict about that to make the pulls smaller, and easier to review.

No they are in the example code in the docstrings. So they are from an earlier iteration.

[ahms5]

thanks, looks fine, in my opinion we are almost there. I dont see any other warinings anymore. you can simply check locally:

make html SPHINXOPTS="-W"

[ahms5]

delete

[ahms5]

delete,
we dont need this level of detail, this subdevision of the analytic model is just internally. From extern you still call all funtions from analytic. e.g. pyrato.analytic.rectangular_room_rigid_walls which is in analytic.py or pyrato.analytic.rectangular_room_impedance from impedance.py. The documentaiton should habe the same style

[sbch22]

thanks, looks fine, in my opinion we are almost there. I dont see any other warinings anymore. you can simply check locally:

make html SPHINXOPTS="-W"

Thanks! Two warnings are being put out upon compilation but they stem from the internal python examples in the Docstrings. In that case this would be a new PR I think

...
updating environment: [new config] 12 added, 0 changed, 0 removed
:13: UserWarning: The figure layout has changed to tight
:12: UserWarning: The figure layout has changed to tight
...

[mberz]

Looking good. I currently cannot trigger the circleci test manually, but they should start if there's another commit on this PR.

The mentioned issues can be taken care of in a separate PR