Comments (6)
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.
what i meant is that you already HAVE a man page, so it exists, but is a bit long.
from python-dyndnsc.
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.
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.
@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.
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)
- add 'Strato.com' to presets.ini
- add support for inwx / docker config HOT 1
- dyndnsc sends an update request even though the IP hasn't changed - thus nsupdate.info flags the domain HOT 6
- AttributeError: 'IPDetectorWebCheck' object has no attribute 'names' HOT 1
- IP Updater executing a shell command
- Dependency Dashboard
- Exit code is 0 even if auth failed
- allow using a preset from the command line HOT 1
- docs tree reordering
- drop iface detector and netifaces dependency? HOT 2
- config file documentation
- add support for route53
- add syslog based logging
- add http proxy support
- Improve diagnostics HOT 1
- Error when using DuckDNS: TypeError: __init__() takes at least 4 arguments (3 given) HOT 2
- drop python 2.6 support
- drop support for python 3.3
- support update services that provide IP auto-detection
- No class named 'webcheck4' could be found HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from python-dyndnsc.