Documentation Updates

[ajay-mk]

Improving Documentation

TODO:

• Separate documentation into user-facing guides and advanced internal documentation.
• Provide clear instructions on building and contributing to documentation, including styles and formats.
• Improve discovery and integration of Python modules related to Sphinx.
• Expand tutorials and documentation on key SeQuant components (TNC, Evaluation, Spin-tracing, Wick Theorem, etc.).

Please share any additional comments below.

[ajay-mk]

#266 is now merged and we can start adding more docs!

[Krzmbrzl]

Looking at https://valeevgroup.github.io/SeQuant/index.html now, I would propose the following additional changes:

• A dedicated landing page that is not just the README of the repository. This would allow us to make the landing page be more integrated with the other doc pages (e.g. there could be a short abstract about what SeQuant is followed by links to the general kinds of documentation that exists)
• The sidebar should have more structure. Right now, it seems like we simply use it as a kind of table of contents. I don't think that'll scale well once we start adding proper user docs.

I would propose taking inspiration from https://docs.xarray.dev/en/stable/index.html

I'll try to create a PR as a suggestion for the above...

[ajay-mk]

I like the landing page in the example, I have seen similar stuff in Einsum docs. Do you know if that is a theme specific feature or do we have to add CSS?

[Krzmbrzl]

The card-index is done via sphinx-design

[Krzmbrzl]

For reference: https://diataxis.fr/ as a potential guideline for how to structure the docs

[ajay-mk]

Updated TODO List

User Documentation:

• Evaluation Code Example
• Python Interface?

Developer Documentation:

• Wick Theorem
• TensorNetworkCanonicalizer