Code Monkey home page Code Monkey logo

Comments (6)

infothrill avatar infothrill commented on May 30, 2024

We should definitely use sphinx, but I'm unsure as to how to structure it nicely. Keeping it short is certainly better than keeping it non-existent.

from python-dyndnsc.

ThomasWaldmann avatar ThomasWaldmann commented on May 30, 2024

what i meant is that you already HAVE a man page, so it exists, but is a bit long.

from python-dyndnsc.

infothrill avatar infothrill commented on May 30, 2024

ah, yes! Maybe build man page using a different sphinx initialization which would allow to specify a smaller subset of the doc? I don't know sphinx well enough...

from python-dyndnsc.

ThomasWaldmann avatar ThomasWaldmann commented on May 30, 2024

it's just a rst file, see an example there:
https://bitbucket.org/thomaswaldmann/moin-2.0/src/f6ee7dd9f400befc5a70af07fdfb688f07df45c4/docs/man/?at=default
https://bitbucket.org/thomaswaldmann/moin-2.0/src/f6ee7dd9f400befc5a70af07fdfb688f07df45c4/docs/conf.py?at=default#cl-223

from python-dyndnsc.

infothrill avatar infothrill commented on May 30, 2024

@ThomasWaldmann I am not sure what else to add at this point. The skeleton man page is in place now. Do you agree?

from python-dyndnsc.

ThomasWaldmann avatar ThomasWaldmann commented on May 30, 2024

I didn't look at dyndnsc stuff recently, but for borgbackup we have some code in setup.py that makes a set of usable length man pages (~ per subcommand).

https://github.com/borgbackup/borg/blob/1.1.3/setup.py#L451

from python-dyndnsc.

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.