mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-20 22:00:58 +00:00
389664e512
This allows for embedding mermaid diagrams in rst files. It uses https://github.com/mgaitan/sphinxcontrib-mermaid For example: .. mermaid:: sequenceDiagram participant Alice participant Bob Alice->John: Hello John, how are you? loop Healthcheck John->John: Fight against hypochondria end Note right of John: Rational thoughts <br/>prevail... John-->Alice: Great! John->Bob: How about you? Bob-->John: Jolly good! Change-Id: I04ee218cfb6e3a6cfdd3f3e189a5a632d5628bee Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/44021 Reviewed-by: Rob Mohr <mohrr@google.com> Commit-Queue: Anthony DiGirolamo <tonymd@google.com>
39 lines
1.2 KiB
Python
39 lines
1.2 KiB
Python
# Copyright 2020 The Pigweed Authors
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
|
# use this file except in compliance with the License. You may obtain a copy of
|
|
# the License at
|
|
#
|
|
# https://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations under
|
|
# the License.
|
|
"""pw_docgen"""
|
|
|
|
import setuptools # type: ignore
|
|
|
|
setuptools.setup(
|
|
name='pw_docgen',
|
|
version='0.0.1',
|
|
author='Pigweed Authors',
|
|
author_email='pigweed-developers@googlegroups.com',
|
|
description='Generate Sphinx documentation',
|
|
packages=setuptools.find_packages(),
|
|
package_data={'pw_docgen': ['py.typed']},
|
|
zip_safe=False,
|
|
install_requires=[
|
|
'sphinx >3',
|
|
'sphinx-rtd-theme',
|
|
|
|
# Diagram generation modules.
|
|
'sphinxcontrib-actdiag',
|
|
'sphinxcontrib-blockdiag',
|
|
'sphinxcontrib-nwdiag',
|
|
'sphinxcontrib-seqdiag',
|
|
'sphinxcontrib-mermaid',
|
|
],
|
|
)
|