Task #9666 (closed)
Opened 12 years ago
Closed 12 years ago
Policy for code highlighting
| Reported by: | sbesson | Owned by: | hflynn |
|---|---|---|---|
| Priority: | major | Milestone: | OMERO-4.4.7 |
| Component: | Documentation | Version: | n.a. |
| Keywords: | n.a. | Cc: | |
| Resources: | n.a. | Referenced By: | n.a. |
| References: | n.a. | Remaining Time: | n.a. |
| Sprint: | n.a. |
Description
Sphinx doc currently only highlights code examples in Python (default highlighting language). However, many of our example use other languages (Java, C, Matlab, Shell...)
As a policy, should we systematically set the code language using Sphinx .. highlight: directive?
If yes, the documentation need to be reviewed for 4.5.
Change History (2)
comment:1 Changed 12 years ago by hflynn
comment:2 Changed 12 years ago by hflynn
- Resolution set to fixed
- Status changed from new to closed
All code should now be highlighted in blocks using :: and indenting, or in line using the double back quotes highlighting as I've reviewed both the developer and sysadmin docs for style. Closing ticket.
Note: See
TracTickets for help on using
tickets.
You may also have a look at Agilo extensions to the ticket.
For the BF docs I've been highlighting code using the double quotes highlighting format (which helpfully won't show up on here). Or using :: and then indenting for blocks. Using the same for the OMERO docs would improve consistency between the two.