[gtk-doc] design: more planning updates
- From: Stefan Sauer <stefkost src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk-doc] design: more planning updates
- Date: Wed, 8 Nov 2017 20:00:45 +0000 (UTC)
commit dc8018a0a5940b387c21277a1068e8f86e5429f9
Author: Stefan Sauer <ensonic users sf net>
Date: Wed Nov 8 20:37:42 2017 +0100
design: more planning updates
Add some commandline experiements.
TODO | 20 ++++++++------------
doc/design-2.x.txt | 17 ++++++++++++++++-
2 files changed, 24 insertions(+), 13 deletions(-)
---
diff --git a/TODO b/TODO
index d881955..01aebfb 100644
--- a/TODO
+++ b/TODO
@@ -460,16 +460,12 @@ grep "gst_caps_is_always_compatible" tags
- extra xsltproc options:
--novalid: saves ~ 0.12 sec
-- perl regexps
- - not really an issue, but we can improve by compiling the regexps
-
http://stackoverflow.com/questions/550258/does-the-o-modifier-for-perl-regular-expressions-still-provide-any-benefit
- - we use $&, $', and $` in several places (comple match, pre-match and post-match).
- Those are slow and once they are used a single time perl prepares them for every match operation.
- Since perl 5.10 one can use the /p flag for matches where this is needed and then use
- ${^PREMATCH} , ${^MATCH} and ${^POSTMATCH}
-- perl profiling
- - http://blog.timbunce.org/2008/07/15/nytprof-v2-a-major-advance-in-perl-profilers/
- perl -d:NYTProf gtkdoc-mkdb ...
- nytprofhtml
- firefox nytprof/index.html
+= python =
+- consider swithcing to this markdown parser
+ https://pythonhosted.org/Markdown/index.html
+- switch intermediate files to json/yaml
+ - we need to pick something, that we can easilly output from plain c (produced by gtkdoc-scangobj)
+ - decl-list.txt and .types would need to stay
+- refactor Read{Args,Declarations,Signals}File to output into a single dictionary each:
+ Signal{Names,Objects,Returns,...}[key] -> Signals[key].{names,objects,returns,...}
diff --git a/doc/design-2.x.txt b/doc/design-2.x.txt
index c4fd7c2..c413131 100644
--- a/doc/design-2.x.txt
+++ b/doc/design-2.x.txt
@@ -111,4 +111,19 @@ options for gtkdocize. Create a stub gtkdoc-mkhtml2 tool.
4.) [unassigned] write gtkdoc/mkhtml2.py
- create templates from the current html for the various page types (refentry,
- index, ...).
\ No newline at end of file
+ index, ...).
+- we won't need content_files and expand_content_files in Makefile.am, mkhtml2
+ would read $(DOC_MODULE)-docs.md (rename to index.md?) and find local links
+ from it
+- convert all hand-written md files starting from the main-doc to html
+
+Open Issues:
+wkhtmltopdf html/*.html tester2.pdf
+Error: This version of wkhtmltopdf is build against an unpatched version of QT, and does not support more
then one input document.
+
+pandoc -r docbook -w markdown_github -o tester-docs.md tester-docs.xml
+- pandoc has no xi:include support
+- if we pipe it through xmllint we convert everything.
+xmllint --noent --xinclude tester-docs.xml | pandoc -r docbook -w markdown -o tester-docs.md
+- the index.md would need to represent the structure the docbook chunker would
+ create
\ No newline at end of file
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]