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
e182e7a3
Commit
e182e7a3
authored
Feb 18, 2020
by
Dominik Charousset
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix setup for read-the-docs manual
(cherry picked from commit
3d4021b9
)
parent
ba2fae29
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
69 additions
and
6 deletions
+69
-6
.gitignore
.gitignore
+4
-0
README.md
README.md
+2
-1
manual/conf.py
manual/conf.py
+17
-5
manual/index.rst
manual/index.rst
+46
-0
No files found.
.gitignore
View file @
e182e7a3
...
...
@@ -6,5 +6,9 @@ blog_release_note.md
build/*
github_release_note.md
html/*
manual/examples
manual/html/*
manual/libcaf_core
manual/libcaf_io
manual/libcaf_openssl
release.txt
README.md
View file @
e182e7a3
...
...
@@ -134,7 +134,8 @@ A SNocs workspace is provided by GitHub user
CAF uses
[
Sphinx
](
https://www.sphinx-doc.org
)
:
```
sh
sphinx-build
.
manual/html
-c
manual
cd
manual
sphinx-build
.
html
```
## Scientific Use
...
...
manual/conf.py
View file @
e182e7a3
...
...
@@ -20,11 +20,16 @@
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import
os
,
sys
,
git
,
re
import
os
,
sys
,
git
,
re
,
pathlib
# -- CAF-specific variables ---------------------------------------------------
conf_dir
=
pathlib
.
Path
(
__file__
).
parent
.
absolute
()
root_dir
=
conf_dir
.
parent
.
absolute
()
# Fetch the CAF version.
import
re
with
open
(
"../libcaf_core/caf/config.hpp"
)
as
f
:
with
open
(
os
.
path
.
join
(
root_dir
,
"libcaf_core/caf/config.hpp"
)
)
as
f
:
match
=
re
.
search
(
'^#define CAF_VERSION ([0-9]+)$'
,
f
.
read
(),
re
.
MULTILINE
)
if
match
==
None
:
raise
RuntimeError
(
"unable to locate CAF_VERSION string in config.hpp"
)
...
...
@@ -36,7 +41,7 @@ with open("../libcaf_core/caf/config.hpp") as f:
# We're building a stable release if the last commit message is
# "Change version to <version>".
repo
=
git
.
Repo
(
os
.
path
.
abspath
(
'..'
)
)
repo
=
git
.
Repo
(
root_dir
)
is_stable
=
repo
.
head
.
commit
.
message
.
startswith
(
"Change version to "
+
version
)
# Generate the full version, including alpha/beta/rc tags. For stable releases,
...
...
@@ -48,7 +53,14 @@ else:
last_commit
=
last_commit_full
[:
7
]
release
=
version
+
"+exp.sha."
+
last_commit
# -- General configuration ------------------------------------------------
# -- Enable Sphinx to find the literal includes -------------------------------
for
dirname
in
[
"examples"
,
"libcaf_core"
,
"libcaf_io"
,
"libcaf_openssl"
]:
dest_dir
=
os
.
path
.
join
(
conf_dir
,
dirname
)
if
not
os
.
path
.
isdir
(
dest_dir
):
os
.
symlink
(
os
.
path
.
join
(
root_dir
,
dirname
),
dest_dir
)
# -- General configuration ----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
...
...
@@ -75,7 +87,7 @@ source_suffix = '.rst'
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc
=
'
manual
'
master_doc
=
'
index
'
# General information about the project.
project
=
u'CAF'
...
...
manual.rst
→
manual
/index
.rst
View file @
e182e7a3
...
...
@@ -10,37 +10,37 @@ Contents
:maxdepth: 2
:caption: Core Library
manual/
Introduction
manual/
Overview
manual/
TypeInspection
manual/
MessageHandlers
manual/
Actors
manual/
MessagePassing
manual/
Scheduler
manual/
Registry
manual/
ReferenceCounting
manual/
Error
manual/
ConfiguringActorApplications
manual/
Messages
manual/
GroupCommunication
manual/
ManagingGroupsOfWorkers
manual/
Streaming
manual/
Testing
Introduction
Overview
TypeInspection
MessageHandlers
Actors
MessagePassing
Scheduler
Registry
ReferenceCounting
Error
ConfiguringActorApplications
Messages
GroupCommunication
ManagingGroupsOfWorkers
Streaming
Testing
.. toctree::
:maxdepth: 2
:caption: I/O Library
manual/
NetworkTransparency
manual/
Brokers
manual/
RemoteSpawn
NetworkTransparency
Brokers
RemoteSpawn
.. toctree::
:maxdepth: 2
:caption: Appendix
manual/
FAQ
manual/
Utility
manual/
CommonPitfalls
manual/
UsingAout
manual/
MigrationGuides
FAQ
Utility
CommonPitfalls
UsingAout
MigrationGuides
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