documentation

How to best version design documents? [closed]

由 ＊爱你＆永不变心＊ 提交于 2019-12-04 08:16:54
问题 Closed . This question is opinion-based. It is not currently accepting answers. Want to improve this question? Update the question so it can be answered with facts and citations by editing this post. Closed last year . There has been some discussion on SO (here and here) before on how office documents can be versioned, however I think my question is still a little different. My programming projects start with a project folder that is empty except for a subfolder named "Design Documents",

Offline Java Documentation [closed]

由 丶灬走出姿态 提交于 2019-12-04 07:59:44
问题 Closed. This question is off-topic. It is not currently accepting answers. Want to improve this question? Update the question so it's on-topic for Stack Overflow. Closed 5 years ago . I've finally gotten around to learning Java and am looking for some documentation for Java that I can download and read offline. Something like Sun's stuff but zipped up or as a PDF or CHM. I'm using Eclipse so something that integrates with that would be nice. It already seems to have some of what I want

Syntax for documenting JSON structure

由 怎甘沉沦 提交于 2019-12-04 07:47:32
问题 So I'm trying to document the format of the json returned by an api I am writing against and I'd like to know if there is any popular format for the documentation of json structure. Note I'm not trying to to test or validate anything, I'm just using this for documentation. Also some ways to add comments to non-constants(items always returned w/ the same value) would be nice. This the not totally thought out scheme I'm currently using: Plain names refer to identifiers or types. Some types have

Documenting Node.js projects [closed]

由 和自甴很熟 提交于 2019-12-04 07:27:26
问题 Closed . This question is opinion-based. It is not currently accepting answers. Want to improve this question? Update the question so it can be answered with facts and citations by editing this post. Closed last year . I'm currently using JSDoc Toolkit to document my code, but it doesn't quite fit - namely, it seem to struggle with describing namespaces properly. Say you have two simple classes in each their files: lib/database/foo.js : /** @class */ function Foo(...) {...} /** @function ...

Sphinx Public API documentation

由 橙三吉。 提交于 2019-12-04 07:24:09
I have a large number of python file and I would like to generate public API documentation for my project. All the functions that are part of the api I have decorated with a decorator. for example: @api def post_comment(comment)" """ Posts a coment """ pass There are other public methods in the same classes. The API is spread among several files each file defining classes with methods and some methods have this @api decorator. How can I tell Sphinx to generate docs just for the public API? I'm answering my own question... After some more had searching I found this: http://sphinx.pocoo.org/ext

Standard methods for documenting a RESTful API [closed]

由 允我心安 提交于 2019-12-04 07:23:24
问题 Closed . This question is opinion-based. It is not currently accepting answers. Want to improve this question? Update the question so it can be answered with facts and citations by editing this post. Closed last year . I'm writing a specification for a RESTful API for a new internal web service. It's not hugely long and fairly simple, but even so, it's my first time using strict REST (as opposed to cheating for practical reasons - avoiding PUT and DELETE because they're a pain in PHP, and so

Compare and contrast the lightweight markup languages [closed]

由 不羁岁月 提交于 2019-12-04 07:21:04
问题 As it currently stands, this question is not a good fit for our Q&A format. We expect answers to be supported by facts, references, or expertise, but this question will likely solicit debate, arguments, polling, or extended discussion. If you feel that this question can be improved and possibly reopened, visit the help center for guidance. Closed 7 years ago . Please identify the most popular lightweight markup languages and compare their strengths and weaknesses. These languages should be

Logging in Scrapy

由 会有一股神秘感。 提交于 2019-12-04 05:41:15
I am having trouble with logging in scrapy, and most of what I can find is out of date. I have set LOG_FILE="log.txt" in the settings.py file and from the documentation, this should work: Scrapy provides a logger within each Spider instance, that can be accessed and used like this: import scrapy class MySpider(scrapy.Spider): name = 'myspider' start_urls = ['http://scrapinghub.com'] def parse(self, response): self.logger.info('Parse function called on %s', response.url) But when I do: class MySpider(CrawlSpider): #other code def parse_page(self,response): self.logger.info("foobar") I get

C# Class Library method summaries are not showing in intellisense

由 梦想与她 提交于 2019-12-04 05:05:47
Fairly self-explanatory I feel I'm guessing here, but if this is your class library, you have to make sure you actually build the XML documentation file, otherwise the method summaries will only be available from within the same assembly. Project Properties -> Build Tab -> Output section -> Check "XML documentation file" Obviously, as Mitchel points out, you have to import it too, but this is generally automatic when you add an assembly reference (as long as it exists). When you build the class library, be sure to put the .xml file that has the documentation in the same folder as the .dll.

Howto add documentation to TYPO3 Extension

由 不问归期 提交于 2019-12-04 04:52:42
Is there a step by step manual how to add documentation to a TYPO3 extension? I added two extensions to the repository but I would like to add some documentation, too. In earlier times of the TYPO3 repository this was quite easy - as far as I can remember a OpenOffice document had to be added to the extension... I found this "howto" I'm using macOS Sierra and I installed a lot of stuff: Xcode, MacPorts, Sphinx,... I did all these pip installs But calling make in the _make directory of the documentation directory of github.com/marble/typo3-docs-typo3-org-resources gives me the following error:
订阅 documentation