Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Problems with the new docs page #139

Closed
PabloAndresCQ opened this issue Jul 10, 2024 · 0 comments
Closed

Problems with the new docs page #139

PabloAndresCQ opened this issue Jul 10, 2024 · 0 comments
Assignees

Comments

@PabloAndresCQ
Copy link
Collaborator

There's some issues with the new version of docs (listed below). As such, for now pytket-cutensornet will continue maintaining the old version of the docs, and using it as the main version. Once these issues are solved, I'm happy to make a another release with the new docs.

  • There currently seems to be a mismatch between the version of the .rst files that are pulled to generate the docs and the version of the source code that is used to build the docs. This is a conjecture, the symptoms are the following:

    • Unreleased changelog is showing in the published docs.
    • The general_state module is not showing up in the published docs. This is likely due to the internal changes in the structure of the modules, I expect that the .rst being used is the most recent in main, which indicates the new paths to the source, but the page is being built using the docstrings of the latest tagged version, so it can't find any source code in that location.
  • Type hints are not showing in the docs.

  • There are some weird typefont issues on the display of the docstrings of arguments. Possibly these can be solved by changing the formatting of the docstrings (line breaks and indentation).

PabloAndresCQ added a commit that referenced this issue Jul 10, 2024
# Description

There's some problems with the new version of docs (listed in the linked
issue). As such, for now `pytket-cutensornet` will continue maintaining
the old version of the docs, and using it as the main version. Once
these issues are solved, I'm happy to make another release switching to
the new docs.

# Related issues

#139
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants