Skip to content

Commit

Permalink
start of work to refactor the docs to use readthedocs
Browse files Browse the repository at this point in the history
This is the first pass to format the previous latex into rst. I have
done the conversion and only started to go through ensuring that
content is preserved (meaning I did not miss anything) and all the code
blocks are formatted (after the automated conversion they indeed are
not!)

Signed-off-by: vsoch <vsoch@users.noreply.github.com>
  • Loading branch information
vsoch authored and hainest committed Apr 3, 2024
1 parent cfa91d0 commit d3a2f2d
Show file tree
Hide file tree
Showing 166 changed files with 14,504 additions and 32,597 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@

name: Documentation

on:
pull_request:
branches: [ master ]
paths: [ docs ]
workflow_dispatch:

jobs:
Build:
runs-on: ubuntu-20.04

steps:
- uses: actions/checkout@v2
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y python3-pip
- name: Build
run: |
set +e
cd docs
python3 -m venv env
source env/bin/activate
pip install -r requirements.txt
`cd $(find env/lib -type d -name sphinxcontrib) && wget https://raw.githubusercontent.com/wpilibsuite/sphinxext-remoteliteralinclude/main/sphinxext/remoteliteralinclude.py`
make html
2 changes: 1 addition & 1 deletion .github/workflows/libabigail.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Build Pull Request
uses: actions/checkout@v3
uses: actions/checkout@v2.4.1
- name: Build
run: |
rm -rf /code
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -126,3 +126,5 @@ cmake-build-*/
.settings
.pydevproject
*__pycache__*
docs/env
docs/_build
30 changes: 0 additions & 30 deletions common/doc/manual_commands.tex

This file was deleted.

119 changes: 0 additions & 119 deletions common/doc/manual_frontpage.tex

This file was deleted.

Binary file removed common/docs/decoding_diagram.png
Binary file not shown.
Binary file removed common/docs/rose_structure.png
Binary file not shown.
7 changes: 0 additions & 7 deletions dataflowAPI/README.md

This file was deleted.

81 changes: 0 additions & 81 deletions dataflowAPI/doc/AST.tex

This file was deleted.

0 comments on commit d3a2f2d

Please sign in to comment.