Skip to content

Commit

Permalink
Add specifications page
Browse files Browse the repository at this point in the history
  • Loading branch information
lukeschmitt-tr committed May 21, 2024
1 parent 62ecd8d commit 11f93e1
Show file tree
Hide file tree
Showing 18 changed files with 1,812 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto
35 changes: 35 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Build and Deploy to GitHub Pages

on:
workflow_dispatch:
pull_request:
push:
branches:
- main

jobs:
deploy:
if: ${{ github.event_name == 'push' }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
submodules: recursive
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.8'
cache: 'pip'
- name: Install Dependencies
run: |
python -m pip install --upgrade pip
pip install --upgrade --requirement ./requirements.txt
- name: Build Site
run: cd docs && make html
- name: Deploy Site
if: ${{ success() }}
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html/
60 changes: 60 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
*.db
*.rdb
*.egg-info
*.log
*.pyc
*.swp
.DS_Store
.cache
.coverage
.coverage.*
.idea
.vagrant
.vscode
.tox
.env
.rope_project/
.ropeproject/
_build
bower_components/
contrib/supervisord.log
contrib/supervisord.pid
celerybeat-schedule.*
deploy/.vagrant
dist/*
docker/azurite
docker/search
local_settings.py
locks/**
logs/*
media/dash
media/epub
media/export
media/external
media/html
media/htmlzip
media/json
media/man
media/pdf
media/static
/static
node_modules
nodeenv
readthedocs/rtd_tests/builds
readthedocs/rtd_tests/tests/builds
user_builds
user_uploads
prod_artifacts
wheelhouse
whoosh_index
xml_output
public_*
private_*
.rope_project/
readthedocs/htmlcov
tags
.python-version
*.pyo
.pytest_cache/
scripts/travis/elasticsearch*
.vscode/
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = Trossen Robotics SLATE Documentation
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Binary file added docs/_static/GitHub-Mark-Light-32px.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/external_link_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/gilmer-regular.ttf
Binary file not shown.
Binary file added docs/_static/github_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 11f93e1

Please sign in to comment.