documentation

问题 I'm writing some documentation with Sphinx and I'd like to print out a certain block of text only for HTML documentation, not for LaTeX documentation. Something tells me I should be able to do this with sphinx.ext.ifconfig but I can't figure out how. Does anyone know how to do this? 回答1: No extension is required. Just use the only directive. It works like this: .. only:: latex The stuff in here only appears in the latex output. .. only:: html The stuff in this block only appears in the HTML

问题 I've seen articles on ::std::thread and ::std::forward and such, but I have seen no good articles on ::std::atomic . There is, of course, the standards proposal paper, but I haven't seen any good documentation for someone who just wanted to use the facility. Is there any? Where can I find it? 回答1: The just::thread library has decent documentation and was developed by Anthony Williams, author of C++ Concurrency in Action and maintainer of the Boost thread library. 回答2: There's also the C++

问题 Delphi has this list: Delphi Intrinsic Routines But that list is incomplete. Which undocumented intrinsic functions exist, since when and what is their purpose? 回答1: I know of the following undocumented intrinsic functions. Delphi 2007: here and Hallvard's blog: Default function Default(T: Typeidentifier): value of T; Returns the zero representation of type identifier T . The following intrinsics introduced in XE7 are explained in the XE7 beta blog and by Stefan Glienke IsManagedType function

问题 I have a large codebase without Javadoc, and I want to run a program to write a skeleton with the basic Javadoc information (e.g., for each method's parameter write @param...), so I just have to fill the gaps left. Anyone know a good solution for this? Edit: JAutodoc is what I was looking for. It has Ant tasks, an Eclipse plugin, and uses Velocity for the template definition. 回答1: The JAutodoc plugin for eclipse does exactly what you need, but with a package granularity : right click on a

问题 Does anyone have documentation pertaining to learning the fundamentals of Linux x86-64 assembly? I'm not sure whether or not to learn it as is, or to learn x86 first, and learn it later, but being as I have an x86-64 computer and not an x86, I was thinking of learning x86-64 instead ;) Maybe someone could give me some incentive, and direction as to learning what, how, and with what documentation. Kindly give me your most favoured documentation titles, I code a little Python, this is my first

问题 I just realized from an article in CACM that Doxygen works with Java (and several other languages) too. But Java has already the Javadoc tool. Can someone explain what are the pros and cons of either approach? Are they mutually exclusive? Is there a Maven plugin for Doxygen? 回答1: Doxygen has a number of features that JavaDoc does not offer, e.g. the class diagrams for the hierarchies and the cooperation context, more summary pages, optional source-code browsing (cross-linked with the

问题 I inherited an existing API and I would like to document it with swagger, but I don't yet know the full scope of it. Can Swagger (or another middleware/tool) auto-magically generate the yaml (for swagger) based on the existing express routes? For what I saw on other questions, it would appear that this is mostly a manual job, but I'm double-checking if someone here found a way around this. 回答1: I have experience in BOTH auto-generating the Swagger json and manually writing it out for an API

问题 I am a C/C++ programmer, and I am currently playing with some Javascript code, and I am having problems finding where the documentation is for the standard Javascript libraries that are available in the browser. Specifically, I am setting an onload callback function on a HTMLImageElement , created with new Image() . I also want to read about the src property, since it has non-standard behavior - when this property is assigned to, the image is reloaded. Mozilla has some skeleton documentation

问题 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 . Ok, so I've read both PEP 8 and PEP 257, and I've written lots of docstrings for functions and classes, but I'm a little unsure about what should go in a module docstring. I figured, at a minimum, it should document the functions and classes that the module exports, but I've

问题 I am trying to document a package in Python. At the moment I have the following directory structure: . └── project ├── _build │ ├── doctrees │ └── html │ ├── _sources │ └── _static ├── conf.py ├── index.rst ├── __init__.py ├── make.bat ├── Makefile ├── mod1 │ ├── foo.py │ └── __init__.py ├── mod2 │ ├── bar.py │ └── __init__.py ├── _static └── _templates This tree is the result of the firing of sphinx-quickstart . In conf.py I uncommented sys.path.insert(0, os.path.abspath('.')) and I have