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

source being appended to rtd builds? #11384

Closed
dylanh724 opened this issue Jun 6, 2024 · 8 comments
Closed

source being appended to rtd builds? #11384

dylanh724 opened this issue Jun 6, 2024 · 8 comments
Labels
Needed: more information A reply from issue author is required Support Support question

Comments

@dylanh724
Copy link

Details

My dir tree:

  • source/
    • conf.py
    • index.rst
    • content/
      • foo.rst

To access foo.rst locally in a toctree, it's content/foo

To access foo.rst in your hosted RST build, it's source/content/foo (as if there's an extra source dir).

Expected Result

Local and RTD should map almost 1:1; I'm not sure what's going on with the "extra" source dir.

Actual Result

Eg:

  • source/
    • conf.py
    • index.rst
      - source/
      - content/
      - foo.rst

For som reason, RST adds the extra source dir. I can either have successful local builds or rtd builds, but not both.

@dylanh724
Copy link
Author

What's odd is that I had a demo of it working in both local and rtd 1:1 -- I tried reverting back and it oddly didn't work (same bug). It's as if RTD just updated and inadvertently appended a source dir. I really want it to be me, but how can I possibly inadvertently add an extra source dir that only shows in rtd and not local?

@dylanh724
Copy link
Author

image

@humitos humitos added the Support Support question label Jun 6, 2024
@stsewd
Copy link
Member

stsewd commented Jun 6, 2024

Hi, please provide the URL of your project on RTD so we can help you.

@stsewd stsewd added the Needed: more information A reply from issue author is required label Jun 6, 2024
@dylanh724
Copy link
Author

dylanh724 commented Jun 7, 2024

Hi, please provide the URL of your project on RTD so we can help you.

Ah, I don't think I'm allowed to, yet. Does this mean checkouts/latest/source/source with the double source is unique to my project, somehow?

Last week, this double source didn't exist. I tried reverting to last week's working rtd and there's still a source/source, leading me to believe there may have been a hosted update bug?

If there was no such update, I'll go back to figuring out what's going on, but just wanting to fact check! Thanks.

@dylanh724
Copy link
Author

dylanh724 commented Jun 7, 2024

There really was an update on June 4th and the 28th, hmm:

https://docs.readthedocs.io/en/stable/changelog.html

Mine last worked late May 27: Seems there were two patches since then. Hmm.

@stsewd
Copy link
Member

stsewd commented Jun 11, 2024

Ah, I don't think I'm allowed to, yet. Does this mean checkouts/latest/source/source with the double source is unique to my project, somehow?

Note that projects on readthedocs.org are public, anyone can see them. We haven't received any other reports related to this, without a build to look at, there isn't much we can do to help or debug this.

Mine last worked late May 27: Seems there were two patches since then. Hmm.

Did a quick look, and don't see anything relevant that may have affected that.

@dylanh724
Copy link
Author

dylanh724 commented Oct 2, 2024

@stsewd https://docs.readthedocs.io/en/stable/changelog.html#version-11-8-1

This update fixed the issue (had to revert my workarounds).

Whatever was between the June 4th, 28th that caused the issue is now fixed in the Oct 1 update.

Overnight, new build content wasn't showing that would build fine locally with only aesthetic content changes. I saw there was a patch and tested reverting my bandaid and... it now works! There really was something that was causing a source/source path.

Although I couldn't find the change that could've patched it when I dove in, I have an itching feeling it has to do with symlink handling: Our content is from a symlinked dir (similar to nginx' approach like sites-available/ and sites-enabled/). That's the only thing we probably do different than the average person.

@humitos
Copy link
Member

humitos commented Oct 2, 2024

I'm happy your issue is solved 👍🏼 . I'm closing this one for now, but feel free to re-open/comment if you consider there is something in our side we can do.

@humitos humitos closed this as not planned Won't fix, can't repro, duplicate, stale Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: more information A reply from issue author is required Support Support question
Projects
None yet
Development

No branches or pull requests

3 participants