Giter Site home page Giter Site logo

Host the docs on the web about chardet HOT 5 CLOSED

chardet avatar chardet commented on June 12, 2024
Host the docs on the web

from chardet.

Comments (5)

sigmavirus24 avatar sigmavirus24 commented on June 12, 2024

@matt-hickford readthedocs is for Sphinx style documentation and I'm not quite certain it will host static sites like that. We might be able to set up GitHub pages to just serve those static files. Can you open a separate issue to track the work to rewrite the documentation using Sphinx?

from chardet.

ssbarnea avatar ssbarnea commented on June 12, 2024

πŸ‘ I was looking for a basic usage example (from inside python) and I was surprised not to find any doc on web.

from chardet.

hickford avatar hickford commented on June 12, 2024

You're right, much easier just to host the html pages we already have on GitHub Pages.

I did it https://hickford.github.io/chardet/

git subtree push --prefix docs origin gh-pages

Don't know how to send a pull request for that branch.

from chardet.

dan-blanchard avatar dan-blanchard commented on June 12, 2024

That documentation is really old (last updated 2009), but it's probably better than nothing. In the long run we should try to switch to using Sphinx and having more thorough API documentation. I'll follow your example to make a gh-pages branch in the meantime.

from chardet.

dan-blanchard avatar dan-blanchard commented on June 12, 2024

Okay. We now have http://chardet.github.io setup as a place for more up-to-date docs, and http://chardet.github.io/chardet for Mark's old docs.

from chardet.

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.