Comments (8)
Changeset r481 adds images to rst markup and links should be easy now.
from idldoc.
Author: mpiper
I'd like to ask for an enhancement to the rst form for the '''Examples''' tag.
I'd like this form:
; :Examples:
; IDL> ; A comment
; IDL> foo
to place pre
tags (or use a monospaced font with line breaks) around the example code in the output, like this:
=== Examples ===
IDL> ; A comment
IDL> foo
from idldoc.
So, you mean
; :Examples:
; Try this example::
;
; IDL> ; A comment
; IDL> foo
is too wordy? I'm not sure I want the Examples section to not have any "regular" text. For example, I could have an Examples section that has some explanation in it:
; :Examples:
; Run the main-level program at the end of this file for an example of using MG_THEMERIVER::
;
; IDL> .run mg_themeriver
;
; This should produce a result like .. image:: themeriver.png
from idldoc.
Author: mpiper
Aha! I didn't read the documentation carefully enough -- I now see how the double colon works.
from idldoc.
Replying to [comment:7 mpiper]:
Aha! I didn't read the documentation carefully enough -- I now see how the double colon works.
The IDL format does do that since there is no double colon markup; everything in the EXAMPLE section is treated as code.
from idldoc.
Also, add special text in backticks, i.e., routine
. Maybe this looks up in the index and makes a link to it?
from idldoc.
r642 adds three levels of heading for rst markup (particularly useful in overviews, .idldoc
files, directory overviews, and file comments).
from idldoc.
r652 adds some basic links. Uses "my_routine" and "text http://michaelgalloy.com" notation with backticks.
from idldoc.
Related Issues (20)
- Subversion keywords are interpreted as equations
- Update to MathJax v2.0 HOT 2
- Ability to show only commands in code snippets HOT 1
- Inherited properties HOT 1
- Use sphinx to generate documentation
- Directives for specific output types
- Problem parsing BEGIN with an extra $ after it HOT 1
- Images not referenced correctly in LaTeX output HOT 1
- Display of links in LaTeX output
- Properties and fields should be in alphabetical order HOT 1
- Make install target
- Fields don't show default value HOT 2
- Make "Get" and "Set" an IDLdoc keyword like "GetProperty" and "SetProperty"
- Shows ancestor class methods HOT 1
- Filter errors/warnings in output
- Update available
- rst code markup should link to online docs HOT 1
- Multiple arguments per line
- COMMENT_STYLE keyword only changes the extension of the output HOT 5
- undefined procedure: 'MGCOARRAYLIST__DEFINE' when running first tutorial example HOT 2
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 idldoc.