Git Product home page Git Product logo

Comments (4)

otsaloma avatar otsaloma commented on June 3, 2024

gna.org shut down, documentation now at otsaloma.io. Build restoration and auto-build + readthedocs.org still needed.

http://otsaloma.io/gaupol/doc/

from gaupol.

winterheart avatar winterheart commented on June 3, 2024

Hello.
ReadTheDocs still needs Sphinx framework, but you don't need generate it manually each time, they updates documentation on each commit. I can restore these parts for you, if you would like it.

from gaupol.

otsaloma avatar otsaloma commented on June 3, 2024

Hello! The reason I never migrated to Read the Docs was that I had written my own documentation auto-generator (doc/sphinx/autogen.py and doc/sphinx/_ext/autoclean.py, see below). That autogen.py was like a preprocessor to be run before sphinx-build and Read the Docs didn't seem to allow running anything else than the sphinx-build step.

https://github.com/otsaloma/gaupol/tree/ac2fdb5206bcf9161e320a581277ec2594039da8/doc/sphinx

So, to restore the API documentation and have it auto-built to Read the Docs, you should probably investigate if that generator I wrote is still needed or does Sphinx these days offer something better and then configure the build system to be compatible with Read the Docs. If you want to look into this, go ahead, it would be a big help!

from gaupol.

otsaloma avatar otsaloma commented on June 3, 2024

Closing as I don't have plans to break the API.

from gaupol.

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.