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
Inconsistent project documentation? #1504
Comments
@tcal-x - This is what you discovered? |
Probably, this is due to missing links in the documentation when building (prjxray docs) on RTD: I will check that |
@mithro It was more that on Prjxray docs, after "fuzzers", "minitests", "tools", then my new "Guide.." appeared. On Symbiflow docs, my new "Guide..." doesn't appear at the same point. So perhaps I need to find another file in which to add a link to the new guide. |
To be clear, this issue is unrelated to my original issue, which is that the link for "Guide to adding a new device to an existing family" is missing from the Symbiflow version of the docs. The underlying reason for my issue may be chipsalliance/f4pga#395 , which blocks the prjxray submodule update on symbiflow-docs. Looking at this PR, now prjxray doc pages have the same section repeated at different points in the hierarchy -- is this intended? Specifically, https://symbiflow--1505.org.readthedocs.build/projects/prjxray/en/1505/db_dev_process/readme.html is linked both from under "Getting Started" and also from under "Database Development Process". However, without this PR (that is, on the current prjxray docs "latest"), this material ("Quickstart Guide", "C++ Development", "Process", ...) doesn't appear anywhere that I can see. So we are jumping from not having the material at all, to having it appear at two places in the hierarchy. I will need to look at it more, and maybe look at the history, to understand what is going on. |
Note: the section repetition (the same material appearing at two places in the hierarchy) is what is currently on the Symbiflow version, so it is not something new introduced in this PR. This PR just makes the Prjxray match the existing Symbiflow organization, which has the duplication. |
The prjxray sphinx docs should be identical when viewed;
The documentation when viewed at https://symbiflow.readthedocs.io/projects/prjxray/en/latest/# has a fairly short list under items;
Yet, when you view the documentation at https://symbiflow.readthedocs.io/en/latest/ you get a much longer output;
The text was updated successfully, but these errors were encountered: