add breathe and doxygen

pull/23262/head
Andrew Tec 4 years ago
parent d28622f8d3
commit bf0b1aa9ea
  1. 1
      Pipfile
  2. 22
      Pipfile.lock
  3. 1
      docs/docker/Dockerfile
  4. 1
      tools/mac_setup.sh
  5. 3
      tools/ubuntu_setup.sh

@ -29,6 +29,7 @@ reverse_geocoder = "*"
scipy = "*" scipy = "*"
sphinx = "*" sphinx = "*"
sphinx-rtd-theme = "*" sphinx-rtd-theme = "*"
breathe = "*"
subprocess32 = "*" subprocess32 = "*"
tenacity = "*" tenacity = "*"

22
Pipfile.lock generated

@ -1,7 +1,7 @@
{ {
"_meta": { "_meta": {
"hash": { "hash": {
"sha256": "3b697db3796ed6f0954ee08eda0b01913add0b5aa83f9f0e484182923fdbc3c2" "sha256": "c9e828f81e737214b3b61a090c34abac03486acf95e461e20f3ba1c08af1aa23"
}, },
"pipfile-spec": 6, "pipfile-spec": 6,
"requires": { "requires": {
@ -998,7 +998,7 @@
"sha256:4ca091dea149f945ec56afb48dae714f21e8692ef22a395223bcd328961b6a0e", "sha256:4ca091dea149f945ec56afb48dae714f21e8692ef22a395223bcd328961b6a0e",
"sha256:7f001e5ac290a0c0401508864c7ec868be4e701886d5b573a9528ed3973d9d3b" "sha256:7f001e5ac290a0c0401508864c7ec868be4e701886d5b573a9528ed3973d9d3b"
], ],
"markers": "python_version >= '3.6'", "markers": "python_version < '3.10'",
"version": "==4.0.1" "version": "==4.0.1"
}, },
"urllib3": { "urllib3": {
@ -1135,6 +1135,14 @@
"markers": "python_version >= '3.6'", "markers": "python_version >= '3.6'",
"version": "==3.2.0" "version": "==3.2.0"
}, },
"breathe": {
"hashes": [
"sha256:19faef9d63c39acb3026eeaf6e6fdc5edb95334ed36fe0c627b358d6a2d5e0da",
"sha256:925eeff96c6640cd857e4ddeae6f75464a1d5e2e08ee56dccce4043583ae2050"
],
"index": "pypi",
"version": "==4.31.0"
},
"certifi": { "certifi": {
"hashes": [ "hashes": [
"sha256:78884e7c1d4b00ce3cea67b44566851c4343c120abd683433ce934a68ea58872", "sha256:78884e7c1d4b00ce3cea67b44566851c4343c120abd683433ce934a68ea58872",
@ -1615,6 +1623,14 @@
"markers": "python_version ~= '3.6'", "markers": "python_version ~= '3.6'",
"version": "==0.2.8" "version": "==0.2.8"
}, },
"mdurl": {
"hashes": [
"sha256:40654d6dcb8d21501ed13c21cc0bd6fc42ff07ceb8be30029e5ae63ebc2ecfda",
"sha256:94873a969008ee48880fb21bad7de0349fef529f3be178969af5817239e9b990"
],
"markers": "python_version >= '3.6'",
"version": "==0.1.0"
},
"mypy": { "mypy": {
"hashes": [ "hashes": [
"sha256:088cd9c7904b4ad80bec811053272986611b84221835e079be5bcad029e79dd9", "sha256:088cd9c7904b4ad80bec811053272986611b84221835e079be5bcad029e79dd9",
@ -2202,7 +2218,7 @@
"sha256:4ca091dea149f945ec56afb48dae714f21e8692ef22a395223bcd328961b6a0e", "sha256:4ca091dea149f945ec56afb48dae714f21e8692ef22a395223bcd328961b6a0e",
"sha256:7f001e5ac290a0c0401508864c7ec868be4e701886d5b573a9528ed3973d9d3b" "sha256:7f001e5ac290a0c0401508864c7ec868be4e701886d5b573a9528ed3973d9d3b"
], ],
"markers": "python_version >= '3.6'", "markers": "python_version < '3.10'",
"version": "==4.0.1" "version": "==4.0.1"
}, },
"urllib3": { "urllib3": {

@ -34,6 +34,7 @@ COPY ./*.md ${OPENPILOT_PATH}/
RUN scons -j$(nproc) RUN scons -j$(nproc)
RUN apt update && apt install doxygen -y
COPY ./docs ${OPENPILOT_PATH}/docs COPY ./docs ${OPENPILOT_PATH}/docs
RUN git init . RUN git init .
WORKDIR ${OPENPILOT_PATH}/docs WORKDIR ${OPENPILOT_PATH}/docs

@ -27,6 +27,7 @@ brew "openssl"
brew "pyenv" brew "pyenv"
brew "qt@5" brew "qt@5"
brew "zeromq" brew "zeromq"
brew "doxygen"
cask "gcc-arm-embedded" cask "gcc-arm-embedded"
EOS EOS

@ -69,7 +69,8 @@ function install_ubuntu_common_requirements() {
libqt5svg5-dev \ libqt5svg5-dev \
libqt5x11extras5-dev \ libqt5x11extras5-dev \
libreadline-dev \ libreadline-dev \
libdw1 libdw1 \
doxygen
} }
# Install Ubuntu 21.10 packages # Install Ubuntu 21.10 packages

Loading…
Cancel
Save