portugalfuturista/seL4
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
2167 commits 1 branch 42 tags 18 MiB
Commit graph

31 commits

Author SHA1 Message Date
Kent McLeod
76dd101fe1 manual: fix python script to be python3 compatible 2017-09-18 11:28:33 +10:00
Anna Lyons
192a4162ee manual: allow non sec autorefs 
Previously anything in an autoref block was assumed to reference
a section, which isn't true. Change 'sec' to 'label' and move the
'sec' prefix into the label itself.
 2017-06-27 16:22:34 +10:00
Anna Lyons
adb7916041 manual: fix double escaping bug 2017-06-20 10:22:59 +10:00
Anna Lyons
cd9e1c9a39 manual: support for itemized lists 2017-06-19 14:43:54 +10:00
Anna Lyons
93d2ed6a77 manual: fix script licenses 2017-06-19 13:59:08 +10:00
Anna Lyons
4d7c272ba7 manual: appease pylint 2017-06-19 13:59:08 +10:00
Anna Lyons
b1ef79e32f manual: refactor + cleanup parse_doxygen_xml.py 
- use 'recursive=False' rather than 'content' to only search children
- use a parse table instead of if a long if/else
- fix nested lists
- use get_text from beautiful_soup rather than home brewed
- don't call latex_escape explicitly
 2017-06-19 13:59:08 +10:00
Anna Lyons
10801bd891 SELFOUR-962: allow API level description in manual 2017-06-19 13:59:08 +10:00
Anna Lyons
c6056ecbe9 SELFOUR-961: allow lists in API docs 
this change

- converts ordered doxygen lists to enumerate
- also wraps the benchmark config names in texttt
 2017-06-19 13:59:08 +10:00
Anna Lyons
6b69024674 manual: use BeautifulSoup in parse_doxygen_xml 
Use BeautifulSoup instead of minidom, for more powerful features
 2017-06-19 13:59:08 +10:00
Stephen Sherratt
e5c0d63c71 manual: Explicitly say TODO where doc is missing 2017-06-02 15:34:45 +10:00
Stephen Sherratt
e29b1e8fb0 manual: Docstrings for gen_invocations script 2017-06-02 15:34:45 +10:00
Stephen Sherratt
aee7a3cbc8 manual: Remove unused import 2017-06-02 15:34:45 +10:00
Stephen Sherratt
7ee77f2933 manual: Comments to docstrings 2017-06-02 15:34:45 +10:00
Stephen Sherratt
748f571855 manual: Include prototypes for undocumented fns 2017-06-02 15:34:45 +10:00
Stephen Sherratt
fee7c9bd0d manual: More robust hanlding of xml errors 
When generating latex from doxygen-generated xml, if an expected element
is not found in the xml, raise a meaningful exception.
 2017-06-02 15:34:45 +10:00
Stephen Sherratt
d8e6a00115 manual: Improve handling of return type docs 
If no documentation is provided for the return value of a function, the
documentation generator will attempt to infer the documentation based on
the return type.
 2017-06-02 15:34:45 +10:00
Stephen Sherratt
c4500519a5 manual: Less fragile handling of arch types 2017-06-02 15:34:45 +10:00
Stephen Sherratt
e426676c63 manual: Handle case where api has no methods 2017-06-02 15:34:45 +10:00
Stephen Sherratt
3180e8ab53 manual: Validate interface files against dtd 2017-06-02 15:34:45 +10:00
Stephen Sherratt
58cbddecff manual: Parameterize \apidoc cmd with section type 2017-06-02 15:34:45 +10:00
Stephen Sherratt
ef74899681 manual: Docstring for gen_invocations stript 2017-05-23 16:27:09 +10:00
Stephen Sherratt
b2c84ed806 manual: Build system compatible with python3 2017-05-23 16:27:01 +10:00
Stephen Sherratt
e0d4bc7fc4 manual: Fixed bug where params out of order in doc 
JIRA: SELFOUR-606
 2016-11-29 14:30:51 +11:00
Stephen Sherratt
7dd19afcde manual: More tags recognised by doxy xml parser 
JIRA: SELFOUR-606
 2016-11-29 14:30:48 +11:00
Stephen Sherratt
03b2f38d51 manual: Tool for generating minimal obj inv header 
JIRA: SELFOUR-606
 2016-11-29 14:30:45 +11:00
Stephen Sherratt
818a8330b3 manual: Added libsel4 tools library to manual dir 
JIRA: SELFOUR-606
 2016-11-29 14:30:02 +11:00
Stephen Sherratt
c464470d6c Syscalls docs in manual generated by doxygen 
This adds a dummy header with syscall prototypes with doxygen comments.
The build process for the manual includes parsing these comments using
doxygen. Doxygen produces an xml file which is parsed by a script to
generate latex which is included in the manual. This approach was chosen
over doxygen's native latex output to gain greater control over the
formatting of the generated documentation, and to take advantage of
existing api-formatting support in the sel4 manual.

Related issue: SELFOUR-606
 2016-09-16 10:09:36 +10:00
Corey Richardson
2e3e09ab92
manual: gen_env: python3 compat 2016-01-25 15:41:58 +11:00
Max R.D. Parmer
da5ec79cf9 Use usr/bin/env for all python bangpaths to enable virtualenv use. 
Very useful with python3 as the default platform.
 2014-08-03 18:53:14 -07:00
TrusthworthySystems
91b7da8625 Release snapshot 2014-07-18 05:03:59 +10:00