documentation

NetBeans 6.5 with Python support provides the docstring documentation for a function/method in a popup when auto-completing, but is there another way to view docstrings? Perhaps achieved by mousing over a function/method name, or clicking somewhere? The best I can seem to do is "Go to source" in the right-click menu. I received the following answer from Tor Norbye at Sun: Hold the ctrl key (or Cmd on Mac) and then hover. Also, Ctrl-Shift-Space (e.g. code completion + shift) will display -just- the completion doc (which means it doesn't just look at the prefix of the caret, but the whole

If I've defined an internal hyperlink target, how can I link to it using arbitrary text as the link title? For example: _`This is a very long internal link target`. ... A `short reference`_ to the very long link target. How could I make the “short reference” target the “very long internal target”? Edit : Another example: Widgets ======= ... Use a `widget`_. How can I make “widget” (singular) link to the “Widgets” (plural) heading? (of course, I realize that this could be done using `widget`_\s … But that doesn't solve the general problem) I haven't found a way to do this using "standard" reST.

Closed . This question needs to be more focused. It is not currently accepting answers. Learn more . Want to improve this question? Update the question so it focuses on one problem only by editing this post . Closed last year . I want to write documentation on my pet project. I have 30 tables and almost 50 views and about 30 functions (stored procedures) in my PostgreSQL database. I would like to see where tables ( which views and which functions ) are used. I would like to see where views ( which views and which functions ) are used. I would like to see if a function is used by another

I just started learning elixir yesterday. I have a file User.exs. It looks like this: defmodule User do @moduledoc """ Defines the user struct and functions to handle users. """ # functions and stuff go here... end When I run iex , this is what happens when I try to see the docs: iex(1)> c "user.exs" [User] iex(2)> h User User was not compiled with docs Any ideas? c("user.exs") compiles the file in memory and does not write the bytecode (.beam file) to disk while h/1 currently requires (details below) the beam file to be present on disk to work. You can make c store the generated bytecode in

I'm using Sphinx on Windows. Most of my documentation is for regular users, but there are some sub-pages with content for administrators only. So I want to build two versions of my documentation: a complete version, and a second version with the "admin" pages excluded. I used the exclude_patterns in the build configuration for that. So far, it works. Every file in every subfolder whose name contains "admin" is ignored when I put this into the conf.py file: exclude_patterns = ['**/*admin*'] The problem is that I'd like to run the build once to get both versions. What I'm trying to do right now

I was looking for a documentation on TA-Lib in Java. I have found the page containing the list of available functions, and found this . I see TADOCS provided the algorithms on some of the functions. However I was not able to understand the required parameters for the function, it does seemed to be mentioned. Is there anywhere where I could find it ? Specifically, I was looking more for LINEARREG Linear Regression Eclipse specifies linear regression as : linearReg(startIdx, endIdx, inReal, optInTimePeriod, outBegIdx, outNBElement, outReal) Is there anywhere I could refer to ? EDITED The other