William/Senior-Design-Project_WMU-Sunseeker_Altium-Designer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed navigation for documentation HTML pages

Browse Source
This commit is contained in:
William Miceli
2021-02-03 17:05:10 -05:00
parent 47d317cac7
commit b723b3f7e1
63 changed files with 397 additions and 239 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/latex/documentation_guide.tex
View File

@@ -1,16 +1,16 @@
\hypertarget{documentation_guide_autotoc_md20}{}\doxysection{Doxygen}\label{documentation_guide_autotoc_md20}
\hypertarget{documentation_guide_autotoc_md19}{}\doxysection{Doxygen}\label{documentation_guide_autotoc_md19}
The program called \char`\"{}doxygen\char`\"{} (\href{https://github.com/doxygen/doxygen}{\texttt{ Git\+Hub Page}} and \href{https://www.doxygen.nl/}{\texttt{ Website}}) is what we\textquotesingle{}re using to document our project and try to make things a bit simpler/easier not only for us, but also future projects or people looking at what we\textquotesingle{}ve done.
It simply uses a small configuration file at the root of the project {\ttfamily /\+Doxyfile} to store some settings, and the rest is through mainly Markdown files ({\ttfamily .md} or {\ttfamily .markdown}) and source code files.
It is setup (as of writing this) that someone can simply open the {\ttfamily /\+Doxyfile} in the GUI Wizard, click on the \char`\"{}\+Run\char`\"{} tab, then \char`\"{}\+Run doxygen\char`\"{}, and everything will be updated... that\textquotesingle{}s it.\hypertarget{documentation_guide_autotoc_md21}{}\doxysection{Updating Documentation}\label{documentation_guide_autotoc_md21}
You need to have installed the program from either the Git\+Hub page or website, then simply open the {\ttfamily /\+Doxyfile} within the GUI frontend or \char`\"{}\+Wizard\char`\"{}.\hypertarget{documentation_guide_autotoc_md22}{}\doxysection{Important Notes}\label{documentation_guide_autotoc_md22}
It is setup (as of writing this) that someone can simply open the {\ttfamily /\+Doxyfile} in the GUI Wizard, click on the \char`\"{}\+Run\char`\"{} tab, then \char`\"{}\+Run doxygen\char`\"{}, and everything will be updated... that\textquotesingle{}s it.\hypertarget{documentation_guide_autotoc_md20}{}\doxysection{Updating Documentation}\label{documentation_guide_autotoc_md20}
You need to have installed the program from either the Git\+Hub page or website, then simply open the {\ttfamily /\+Doxyfile} within the GUI frontend or \char`\"{}\+Wizard\char`\"{}.\hypertarget{documentation_guide_autotoc_md21}{}\doxysection{Important Notes}\label{documentation_guide_autotoc_md21}
\begin{DoxyItemize}
\item Make sure that the {\ttfamily /\+Doxyfile} stays where it\textquotesingle{}s at! It should be kept at the root directory (just to keep things simple)
\item Make sure you use RELATIVE paths when changing configurations, or else when someone else tries running the {\ttfamily /\+Doxyfile}, they\textquotesingle{}ll have to re-\/do all of them in order for it to start functioning again.
\item {\bfseries{DO NOT}} put any files into the {\ttfamily /\+Documentation} folder manually, as they {\bfseries{WILL BE DELETED}} when doxygen is run.
\end{DoxyItemize}\hypertarget{documentation_guide_autotoc_md23}{}\doxysubsection{For Consistency}\label{documentation_guide_autotoc_md23}
\end{DoxyItemize}\hypertarget{documentation_guide_autotoc_md22}{}\doxysubsection{For Consistency}\label{documentation_guide_autotoc_md22}
\begin{DoxyItemize}
\item Please make sure the internal names (\char`\"{}tags\char`\"{}) of files are using \char`\"{}camel\+Case\char`\"{}

21
Documentation/latex/index.tex
View File

@@ -1,17 +1,8 @@
{\bfseries{Subpages}}
\begin{DoxyItemize}
\item \mbox{\hyperlink{hardware}{Hardware}}
\item \mbox{\hyperlink{software}{Software}}
\end{DoxyItemize}
\DoxyHorRuler{0}
\hypertarget{index_autotoc_md15}{}\doxysection{About}\label{index_autotoc_md15}
What this project is about (TODO)\hypertarget{index_autotoc_md16}{}\doxysection{Documentation}\label{index_autotoc_md16}
\hypertarget{index_autotoc_md14}{}\doxysection{About}\label{index_autotoc_md14}
What this project is about (TODO)\hypertarget{index_autotoc_md15}{}\doxysection{Documentation}\label{index_autotoc_md15}
For Documentation, we will use \char`\"{}doxygen\char`\"{} to easily create documentation pages for the project. This will be accessible in a variety of means, but primarily through HTML pages accessible through a browser, covering all aspects of the project.
More information here\+: \mbox{\hyperlink{documentation_guide}{Documentation Guide}}\hypertarget{index_autotoc_md17}{}\doxysubsection{Tips from Dr. Bazuin}\label{index_autotoc_md17}
More information here\+: \mbox{\hyperlink{documentation_guide}{Documentation Guide}}\hypertarget{index_autotoc_md16}{}\doxysubsection{Tips from Dr. Bazuin}\label{index_autotoc_md16}
\begin{DoxyItemize}
\item Make sub-\/circuits/sub-\/designs for schematics to keep things organized and modular/copy-\/able
@@ -28,13 +19,15 @@ More information here\+: \mbox{\hyperlink{documentation_guide}{Documentation Gui
\item Document things as we go
\item Need to make sure we have a BOM
\item Free samples for parts from manufacturers
\end{DoxyItemize}\hypertarget{index_autotoc_md18}{}\doxysubsection{Tips from Dr. Gomez}\label{index_autotoc_md18}
\item Make peripherals like output on one side and inputs on the other
\item Use SPI Chip Select as a separate command (Use 3-\/pin SPI and then just use GPIO for Chip Select)
\end{DoxyItemize}\hypertarget{index_autotoc_md17}{}\doxysubsection{Tips from Dr. Gomez}\label{index_autotoc_md17}
\begin{DoxyItemize}
\item Our requirements/specifications should be made to be more measurable
\item Need to design to safety standards, which need to be researched online
\item He said that he is available himself for anything power-\/related to help out with if needed
\end{DoxyItemize}\hypertarget{index_autotoc_md19}{}\doxysection{TODO List}\label{index_autotoc_md19}
\end{DoxyItemize}\hypertarget{index_autotoc_md18}{}\doxysection{TODO List}\label{index_autotoc_md18}
\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Make battery circuitry for Real-\/\+Time Clock/\+Calendar for when the vehicle is off.

2
Documentation/latex/refman.tex
View File

@@ -171,7 +171,7 @@
\hypersetup{pageanchor=true}
%--- Begin generated contents ---
\chapter{Main Page}
\chapter{Home}
\label{index}\hypertarget{index}{}\input{index}
\chapter{Hardware}
\label{hardware}