Sphinx and inherited functions

I'm trying to use Sphinx to document my Python code and I'm new to Sphinx. I'm in the following situation: from abc import ABCMeta from abc import abstractmethod class AbstractClass1(): __metaclass__ = ABCMeta def __init__(self): ...
more »

2017-12-02 14:12 (0) Answers

Why does YARD require parameters to be named?

I've just started using YARD to document Ruby code and am very new to how it works. Forgive me if this is a basic question that has been asked before but I can't find any answer to it. If I document my code like the following example and run yardoc ...
more »

2017-12-02 13:12 (0) Answers

UML Diagrams and documentation

I have a few question since i don't know much about UML. Is it correct to use UML Diagrams to document a webapp that was made using structured programming? When you about to document, should you use all diagrams or just the ones that explain good e...
more »

2017-11-28 16:11 (3) Answers

Troubleshooting model generation

Is there any tool which can produce troubleshooting model similar to the one below, from text file? Requirement is that this text file have to be useful on its own. In other words, it have to be readable in raw form. Ideally this tool should be supp...
more »

2017-11-28 11:11 (0) Answers

jsdoc requires either one of the parameters

Is there a way to annotate either one to be required in jsdoc? So for example, if I have the following function /** * @param {object} opt * @param ... * @param {string} opt.school * @param {number} opt.schoolId * @param ... */ function foo (op...
more »

2017-11-27 09:11 (0) Answers

UI Documentation for Operations

Thoughts on how to provide good documentation to the operations team on how to figure out why things are not working as expected? Documenting code and apis is 'easy' jdoc, jsdoc, doxy, swagger, etc How do you go about documenting the user interface...
more »

2017-11-24 19:11 (0) Answers

properties supported by vboxmanage mediumproperty

VirtualBox supports the command vboxmanage mediumproperty to "set up, get or delete a medium property". Can this command be used to get the size of a medium (i.e. in a more direct way than via vboxmanage showmediuminfo)? I've been trying to find doc...
more »

2017-11-23 09:11 (0) Answers

Python 3 Documentation - Function Annotation

I use the following format to document my Python code: def my_function(param: str) -> dict: some code I can't figure out how to document a function passed to another function. For example: def my_function(my_other_function: ???) -> dict...
more »

2017-11-23 08:11 (1) Answers

Hyperledger documentation questions

I am going through the Hyperledger documentation on architecture. I am not able to follow some of the symbols and text. For example, Both V and N contain a special element \bot, What does \bot mean? for k\in K and v\in V, What do k\ and...
more »

2017-11-22 15:11 (1) Answers

How to document the following JS class

I have a problem with functions like this that represent classes: MyClassName_g = Class_g(InheritClass_g, { propertyA: 'string', propertyB: 5, propertyC: null, constructor: function(param){ this.propertyC = param; }, ...
more »

2017-11-21 17:11 (0) Answers

Word 2010: Add a Note with Multiple Bullets

Does anyone know how to add in Word a "Notes" paragraph, with upper and lower borders, and with multiple note items? It should look as follows, but include upper and lower borders on top of "Notes" and below the last "List Item". Notes: List it...
more »

2017-11-21 08:11 (0) Answers

How to use mwapi library to get a wikipedia page?

I have been trying to figure out the documentation of the mwapi library (MediaWiki API) and I cannot figure out how to simply request a page based on a search query or keyword. I know I should use get() but filling in the parameters with keywords yie...
more »

2017-11-21 00:11 (1) Answers

Documentation for OpenCV3 python bindings?

Is there any documentation for the python-equivalents of the C++ source documented here I'm using the python bindings/wrappers around the C++ source and sometimes will get usage wrong but don't have a place to reference. ...
more »

2017-11-20 04:11 (1) Answers

Analysis of new development tools for company

I have been asked to produce a document describing the use a new technology within our organisation concentrating on specific use cases where this technology could be used and how. Is there a name for this kind of document (or at least a type of doc...
more »

2017-11-16 20:11 (0) Answers

Support Center softwares generators?

I am wondering if anyone knows any good "help" center software used by big companies, or what software is exactly used to generate these documents, I'll leave a few example sites: https://help.instagram.com/370452623149242 https://help.market.envat...
more »

2017-11-16 19:11 (0) Answers