Coder Social home page Coder Social logo

CI: RTD build is useless about crate-docs-theme HOT 6 CLOSED

amotl avatar amotl commented on June 30, 2024
CI: RTD build is useless

from crate-docs-theme.

Comments (6)

msbt avatar msbt commented on June 30, 2024

@amotl I've compared the raw logs from the Run build before upgrading to Sphinx 5 docs #338 build with some of earlier runs (e.g. SEO improvements (content wider than screen) and other smaller fixes build #283) and it seems that there are a few things missing.

I can't find the line with .env/bin/pip3 install -r requirements.txt which subsequently would install nodeenv and all the webpack stuff. It also says Using legacy 'setup.py install' for livereload, since package 'wheel' is not installed. which it doesn't on the older build. I reckon that's why the bundle/main.js with its assets is missing.

from crate-docs-theme.

amotl avatar amotl commented on June 30, 2024

Hi @msbt,

thank you for your investigations.

I've compared the raw logs [...]

By following the links you provided, I am sorry having to tell you that you compared apples with oranges: One job is about "Build docs on...", the other one is about "Build package on...". So, those are two different jobs, naturally having a different output.

I reckon that's why the bundle/main.js with its assets is missing.

Ah, is it?

With kind regards,
Andreas.

from crate-docs-theme.

amotl avatar amotl commented on June 30, 2024

Now I am seeing it. I think there are two anomalies.

Application bundle missing

This is what you reported, @msbt, right?

GET https://crate-docs-theme--349.org.readthedocs.build/en/349/_static/bundle/main.js?ver=0.24.5
Status: 404 Not Found

Wrong project association

I believe the documentation of crate-docs-theme thinks it is both associated with the project crate-docs-theme, as well as fake, which looks like it is not published at the moment.

GET https://crate.io/docs/fake/_/static/javascript/readthedocs-doc-embed.js?ver=0.24.5
Status: 404 Not Found

Outlook

  1. Investigate why the application bundle file bundle/main.js is not present.
  2. Investigate the misguidedness of the project name/url, wrt. crate-docs-theme vs. fake.

from crate-docs-theme.

msbt avatar msbt commented on June 30, 2024

@amotl yes, exactly, I was investigating why main.js (and related assets) from the webpack bundler aren't present and those were the attempts to figure out why. Thanks for checking those out!

from crate-docs-theme.

amotl avatar amotl commented on June 30, 2024

Investigate why the application bundle file bundle/main.js is not present.

Oh it just occurred to me that this would actually be expected. While the JavaScript/CSS bundle is part of the package published to PyPI, it is obviously missing on a bare repository checkout and would need to be bundled beforehand.

So, this is actually a natural implication of #255. webpack probably can't run on RTD, so we will have to come up with a different solution.

from crate-docs-theme.

amotl avatar amotl commented on June 30, 2024

GH-379 fixed this issue, so rendering previews and finals on RTD works well now.

-- https://crate-docs-theme.readthedocs.io/

from crate-docs-theme.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.