I downloaded and installed Review Board in order to evaluate its fit for our team's workflow. I see that you can attach files to a review. When I go to review an attached file, Review Board lets me add a comment to the entire file, but I don't see a way to comment on individual lines within the file.
How can I comment on individual lines in an attached source file?
According to the official documentation for the current version (more specifically, see Creating Review Requests and Reviewing File Attachments page), it is only possible to comment on non-diff files as a whole. I have tried to find a workaround, but I have not been successful.
This wiki page, which contains ideas for the 2.0 version, says the following:
There has been some request for reviewing files other than diffs.
Screenshots have been the main one, though someone suggested Wiki
changes and specialized views for certain text documents.
So maybe this will be possible in 2.0, but as of 1.7, it is not possible.
Related
I know there is way to copy static files via jsdoc, for images as example.
Is there a way to "extend" the generated template via markdown or html files that integrate into the "look & feel" of the used theme?
I know you can include one markdown file as "landing page", but i wonder if its possible to add more pages/files.
Why im asking this?
Because i want to generate the documentation out of my source code and add then some additional pages which describe the workflow of my application or the behavior of some components.
Doing this in a single markdown document & that as "landing page" seems not a good solution.
I cant imagine that there exist not a "read to use" solution.
I just want a nice & complete documentation of my application which includes stuff from the source code and additional pages.
Any hint is welcome.
Thanks in Advance.
In one open source project, I saw that they were including GeoIP.h header file and calling their functions to know the country code of an IP. I wonder where is the database used by GeoIP.h
I went through the source code of GeoIP.h at
http://www9.biostr.washington.edu/webalizer/src/stonesteps.ca/webalizer_src_3_4_4_1/GeoIP.h
It uses a variable FILE *GeoIPDatabase; Please suggest. I need the whole database.
===EDIT===
The source code I am visiting is this. It doesn't mention any database to be used!
https://github.com/lampeh/libvmod-geoip/blob/master/src/vmod_geoip.c.
It's available for download on the Maxmind web site. A basic free version is available at:
http://dev.maxmind.com/geoip/legacy/geolite/
More detailed databases are also available for purchase.
Are you looking for this? (see downloads section)
http://dev.maxmind.com/geoip/legacy/geolite/
You can download either CSV or binary data files.
Is it possible to embed code to Trac wiki page straight from source code? I mean code blocks, not links pointing to the source. Like
MyCode.java contents
Look at IncludeMacro which is also able to embed from source repository (keyword source:).
Furthermore you can copy source code to wiki and format it with syntax-highlighting, for example:
{{{
#!python
hello = lambda: "world"
}}}
Read more about it here.
You're using 'code blocks' in a way that makes me think of partial citation.
As falkb pointed out, IncludeMacro is the current best way of embedding Trac (and even external) content into a Trac resource, that is rendered with support for Trac's WikiFormatting. But sadly, there is NO such partial citation capability yet.
You may want to at least request it as enhancement for the aforementioned plugin, and could even push it closer to reality by providing valid use case example - or better: some real code to make it happen. Be prepared to test code, if a patch is proposed or - ideally - if the trunk (development) branch receives changes to make partial citation happen.
Question
(run-marginalia {})
produces a single file, docs/uberdoc.html
I would prefer it to produce many files in docs/*, one per *.clj file
Motivation:
I really like marginalia. I have recently started using it, and it's causing me to want to write documentation, as impossible as that sounds.
However, I have this problem that whenever I write docs, and refresh, and reload uberdoc.html, I lose the part of the doc I was previously looking at. Thus, I would prefer a system where each *.clj file had it's on *.html file for documentation. Is this possible with marginalia 0.7.0?
Thanks!
There was a mutlidoc functionality in a previous version, but it is not at command line in the latest version. However, by running something like (multidoc! "./docs" (find-processable-file-paths "./src" #"\.clj$") {}) you should get directory of individual files.
https://github.com/weavejester/codox is another Clojure documentation tool (which gives separate pages - see http://number23.github.com/commons-lib/)
I'm going to manage some documentation using Django (I come from Sphinx) in order to have more control on the output. The docs are in rst (restructured text) in a git archive, and it's trivial to display them in HTML using a filter. My problem is that they are quite long, and I'd like to have more control on how the pagination goes, so I can show a single section per HTML page, have comments for a single section and so on...
My goal would be to be able to parse each doc, create my TOC with links to each section in a separate HMTL page, where a view would go through whole doc to render in html just a section.
I understand that it's mostly a issue of docutils, the most interesting example I've been able to find is: http://www.ibm.com/developerworks/library/x-matters24/#code2 but it seems outdated and the examples in section "Tree-oriented processing", which is where the magic goes, don't seem work with my version of docutils. Article is good: I could use more of the same subject!
Is there something similar to what I'm planning to do already available that I can study, or maybe could someone point me to a gentle introduction to docutils for parsing rst documents?
Here is a blog describing howto make a custom rst writer and call it from Django. I think it should give you a good start http://www.arnebrodowski.de/blog/write-your-own-restructuredtext-writer.html
Pygments has a ReST lexer that you could examine (or possibly even use directly).