Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
A
Actor Framework
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Metrics
Environments
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
cpp-libs
Actor Framework
Commits
fd1507aa
Commit
fd1507aa
authored
May 01, 2019
by
Dominik Charousset
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Clean up build process for .rst manual
parent
9fe55868
Changes
9
Hide whitespace changes
Inline
Side-by-side
Showing
9 changed files
with
40 additions
and
445 deletions
+40
-445
doc/CMakeLists.txt
doc/CMakeLists.txt
+10
-0
doc/cmake/index.rst.in
doc/cmake/index.rst.in
+0
-0
doc/tex/conf.py
doc/tex/conf.py
+0
-336
doc/tex/exec_pandoc.sh
doc/tex/exec_pandoc.sh
+0
-20
doc/tex/explode_lstinputlisting.py
doc/tex/explode_lstinputlisting.py
+0
-41
doc/tex/index_footer.rst
doc/tex/index_footer.rst
+0
-8
doc/tex/index_header.rst
doc/tex/index_header.rst
+0
-8
doc/tex/make_index_rst.py
doc/tex/make_index_rst.py
+0
-32
scripts/make_index_rst.py
scripts/make_index_rst.py
+30
-0
No files found.
doc/CMakeLists.txt
View file @
fd1507aa
...
@@ -123,9 +123,19 @@ if (CAF_BUILD_TEX_MANUAL)
...
@@ -123,9 +123,19 @@ if (CAF_BUILD_TEX_MANUAL)
message
(
STATUS
"Add optional target: rst."
)
message
(
STATUS
"Add optional target: rst."
)
add_custom_target
(
rst
)
add_custom_target
(
rst
)
add_dependencies
(
doc rst
)
add_dependencies
(
doc rst
)
# generate .rst files for individual sections
foreach
(
texfile
${
sources
}
)
foreach
(
texfile
${
sources
}
)
generate_rst
(
${
texfile
}
)
generate_rst
(
${
texfile
}
)
endforeach
()
endforeach
()
# generate index.rst file from manual.tex
add_custom_target
(
"index.rst"
DEPENDS
"tex/manual.tex"
COMMAND
"python"
"
${
CMAKE_SOURCE_DIR
}
/scripts/make_index_rst.py"
"
${
CMAKE_CURRENT_BINARY_DIR
}
/rst/index.rst"
"
${
CMAKE_SOURCE_DIR
}
/doc/tex/manual.tex"
WORKING_DIRECTORY
"
${
CMAKE_CURRENT_BINARY_DIR
}
/rst"
)
add_dependencies
(
rst
"index.rst"
)
endif
()
endif
()
endif
()
endif
()
endif
()
endif
()
...
...
doc/
tex/index.rst
→
doc/
cmake/index.rst.in
View file @
fd1507aa
File moved
doc/tex/conf.py
deleted
100644 → 0
View file @
9fe55868
# -*- coding: utf-8 -*-
#
# CAF documentation build configuration file, created by
# sphinx-quickstart on Fri Jun 3 11:27:36 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
import
sphinx_rtd_theme
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions
=
[]
# Add any paths that contain templates here, relative to this directory.
templates_path
=
[
'_templates'
]
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix
=
'.rst'
# The encoding of source files.
#
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc
=
'index'
# General information about the project.
project
=
u'CAF'
copyright
=
u'2016, Dominik Charousset'
author
=
u'Dominik Charousset'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version
=
u'0.16.0'
# The full version, including alpha/beta/rc tags.
release
=
u'0.16.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language
=
None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#
# today = ''
#
# Else, today_fmt is used as the format for a strftime call.
#
# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns
=
[
'_build'
,
'Thumbs.db'
,
'.DS_Store'
]
# The reST default role (used for this markup: `text`) to use for all
# documents.
#
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#
# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style
=
'sphinx'
highlight_language
=
'C++'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos
=
False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme
=
'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path
=
[
sphinx_rtd_theme
.
get_html_theme_path
()]
# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#
# html_title = u'CAF v0.15'
# A shorter title for the navigation bar. Default is the same as html_title.
#
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path
=
[
'_static'
]
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#
# html_extra_path = []
# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#
# html_last_updated_fmt = None
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#
# html_additional_pages = {}
# If false, no module index is generated.
#
# html_domain_indices = True
# If false, no index is generated.
#
# html_use_index = True
# If true, the index is split into individual pages for each letter.
#
# html_split_index = False
# If true, links to the reST sources are added to the pages.
#
# html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
#
# html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# 'ja' uses this config value.
# 'zh' user can custom change `jieba` dictionary path.
#
# html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#
# html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename
=
'CAFdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements
=
{
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents
=
[
(
master_doc
,
'CAF.tex'
,
u'CAF Documentation'
,
u'Dominik Charousset'
,
'manual'
),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#
# latex_use_parts = False
# If true, show page references after internal links.
#
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
#
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
#
# latex_appendices = []
# If false, no module index is generated.
#
# latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages
=
[
(
master_doc
,
'caf'
,
u'CAF Documentation'
,
[
author
],
1
)
]
# If true, show URL addresses after external links.
#
# man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents
=
[
(
master_doc
,
'CAF'
,
u'CAF Documentation'
,
author
,
'CAF'
,
'One line description of project.'
,
'Miscellaneous'
),
]
# Documents to append as an appendix to all manuals.
#
# texinfo_appendices = []
# If false, no module index is generated.
#
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#
# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#
# texinfo_no_detailmenu = False
doc/tex/exec_pandoc.sh
deleted
100755 → 0
View file @
9fe55868
#!/bin/bash
blacklist
=
"manual.tex variables.tex colors.tex newcommands.tex"
inBlacklist
()
{
for
e
in
$blacklist
;
do
[[
"
$e
"
==
"
$1
"
]]
&&
return
0
done
return
1
}
for
i
in
*
.tex
;
do
if
inBlacklist
$i
;
then
continue
fi
out_file
=
$(
basename
$i
.tex
)
echo
"
$i
=>
$out_file
"
cat
colors.tex variables.tex newcommands.tex
$i
| ./explode_lstinputlisting.py | pandoc
--filter
=
$PWD
/filter.py
--wrap
=
none
--listings
-f
latex
-o
${
out_file
}
.rst
done
sphinx-build
-b
html
.
html
doc/tex/explode_lstinputlisting.py
deleted
100755 → 0
View file @
9fe55868
#!/usr/bin/env python
import
sys
import
re
def
parse_range
(
astr
):
result
=
set
()
for
part
in
astr
.
split
(
','
):
x
=
part
.
split
(
'-'
)
result
.
update
(
range
(
int
(
x
[
0
]),
int
(
x
[
-
1
])
+
1
))
return
sorted
(
result
)
def
print_listing
(
line_range
,
fname
):
print
(
'
\\
begin{lstlisting}'
)
if
not
line_range
:
with
open
(
fname
,
'r'
)
as
fin
:
sys
.
stdout
.
write
(
fin
.
read
())
else
:
with
open
(
fname
)
as
mfile
:
for
num
,
line
in
enumerate
(
mfile
,
1
):
if
num
in
line_range
:
sys
.
stdout
.
write
(
line
)
print
(
'
\\
end{lstlisting}'
)
def
cppexample
(
line_range
,
fname
):
print_listing
(
line_range
,
'../../examples/{0}.cpp'
.
format
(
fname
))
def
iniexample
(
line_range
,
fname
):
print_listing
(
line_range
,
'../../examples/{0}.ini'
.
format
(
fname
))
def
sourcefile
(
line_range
,
fname
):
print_listing
(
line_range
,
'../../{0}'
.
format
(
fname
))
rx
=
re
.
compile
(
r"\\(cppexample|iniexample|sourcefile)(?:\[(.+)\])?{(.+)}"
)
for
line
in
sys
.
stdin
:
m
=
rx
.
match
(
line
)
if
not
m
:
sys
.
stdout
.
write
(
line
)
else
:
locals
()[
m
.
group
(
1
)](
parse_range
(
m
.
group
(
2
)),
m
.
group
(
3
))
doc/tex/index_footer.rst
deleted
100644 → 0
View file @
9fe55868
Version Information
===================
This version of the Manual was automatically generated from CAF commit
`903f801c <https://github.com/actor-framework/actor-framework/commit/903f801c>`_
and Manual commit
`a4604f9 <https://github.com/actor-framework/manual/commit/a4604f9>`_.
doc/tex/index_header.rst
deleted
100644 → 0
View file @
9fe55868
CAF User Manual
===============
**C++ Actor Framework** version 0.16.0.
Contents
========
doc/tex/make_index_rst.py
deleted
100755 → 0
View file @
9fe55868
#!/usr/bin/env python
# Generates the content for an index.rst file
# from the content of a manual.tex file
import
re
import
sys
def
print_header
():
sys
.
stdout
.
write
(
".. include:: index_header.rst
\n
"
)
def
print_footer
():
sys
.
stdout
.
write
(
"
\n
.. include:: index_footer.rst
\n
"
)
part_rx
=
re
.
compile
(
r"\\part{(.+)}"
)
include_rx
=
re
.
compile
(
r"\\include{(.+)}"
)
print_header
()
for
line
in
sys
.
stdin
:
m
=
part_rx
.
match
(
line
)
if
m
:
sys
.
stdout
.
write
(
"
\n
.. toctree::
\n
"
" :maxdepth: 2
\n
"
" :caption: "
)
sys
.
stdout
.
write
(
m
.
group
(
1
))
sys
.
stdout
.
write
(
"
\n\n
"
)
continue
m
=
include_rx
.
match
(
line
)
if
m
:
sys
.
stdout
.
write
(
" "
)
sys
.
stdout
.
write
(
m
.
group
(
1
))
sys
.
stdout
.
write
(
"
\n
"
)
print_footer
()
scripts/make_index_rst.py
0 → 100755
View file @
fd1507aa
#!/usr/bin/env python
# Generates the content for an index.rst file
# from the content of a manual.tex file.
#
# Usage: make_index_rst.py <output-file> <input-file>
import
re
import
sys
part_rx
=
re
.
compile
(
r"\\part{(.+)}"
)
include_rx
=
re
.
compile
(
r"\\include{tex/(.+)}"
)
with
open
(
sys
.
argv
[
1
],
'w'
)
as
out_file
:
out_file
.
write
(
".. include:: index_header.rst
\n
"
)
with
open
(
sys
.
argv
[
2
])
as
tex_file
:
for
line
in
tex_file
:
m
=
part_rx
.
match
(
line
)
if
m
:
out_file
.
write
(
"
\n
.. toctree::
\n
"
" :maxdepth: 2
\n
"
" :caption: "
)
out_file
.
write
(
m
.
group
(
1
))
out_file
.
write
(
"
\n\n
"
)
continue
m
=
include_rx
.
match
(
line
)
if
m
:
out_file
.
write
(
" "
)
out_file
.
write
(
m
.
group
(
1
))
out_file
.
write
(
"
\n
"
)
out_file
.
write
(
"
\n
.. include:: index_footer.rst
\n
"
)
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment