GithubHelp home page GithubHelp logo

Documentation setup thoughts about brevitas HOT 3 OPEN

V0XNIHILI avatar V0XNIHILI commented on August 21, 2024
Documentation setup thoughts

from brevitas.

Comments (3)

Giuseppe5 avatar Giuseppe5 commented on August 21, 2024 1

We need to commit them because they are automatically picked up by GitHub to generate the documentation website.

I know that there are alternatives to this approach and maybe we'll switch in the future but I wouldn't say it's a priority at the moment

from brevitas.

Giuseppe5 avatar Giuseppe5 commented on August 21, 2024

I believe we have a similar setup, with the HTML files in the doc folder being automatically generated starting from the .rst files in the docsrc folder.

from brevitas.

V0XNIHILI avatar V0XNIHILI commented on August 21, 2024

Ah right, I didnt see that, thanks! Maybe it would be better not to commit the HTML files though, because now both the source and the generated files are commited: so every time one file changes, another one changes too and it contains the same information. For example, whenever I was searching through the code base for some things, I found references in many HTML files, but those files are hard to read in a text editor.

from brevitas.

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.