-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add coordinate-frames.doxygen.md to Doxygen alongside .dox
Update README.md to act as the Doxygen mainpage and include additional information about the motivation for this project. Add links from there to Doxygen output .html pages generated by two files: - coordinate-frames.dox (already part of repository) - coordinate-frames.doxygen.md (new) Create coordinate-frames.doxygen.md (Doxygen Markdown format) file by copying the Jupytext Markdown format output file coordinate-frames.md and performing a few find and replace operations: Find | Replace ----------|----------- $$ (start)| \f[ $$ (end) | \f] $ | \f$ Surround the jupytext metadata with <!-- --> instead of --- to comment it out during Doxygen processing.
- Loading branch information
Showing
4 changed files
with
383 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,28 @@ | ||
Software used to develop this codebase: | ||
Attempting to find the best combination of two tools: | ||
- Doxygen for overall project documentation | ||
- Jupyter Notebook for quick interactive visualizations | ||
|
||
Generate the Doxygen `html` documentation package: | ||
|
||
doxygen Doxyfile | ||
|
||
Will Jupytext allow us to keep these files in sync? | ||
|
||
Synced | File | Description | Links to Doxygen Output | ||
---------|-----------------------------|------------------------------------|--------------- | ||
Manually | coordinate-frames.dox | Doxygen C-style comment file | [.html page name](coordinate-frames-dox.html) and [\\ref command](\ref coordinate-frames-dox) | ||
Manually | coordinate-frames.doxygen.md | Doxygen Markdown format | [.html page name](md_coordinate-frames_8doxygen.html) and [.md file name](coordinate-frames.doxygen.md) | ||
Jupytext | coordinate-frames.ipynb | Jupyter Notebook for interaction || | ||
Jupytext | coordinate-frames.md | Jupytext (GitHub?) Markdown format || | ||
Jupytext | coordinate-frames.py | Python script || | ||
|
||
|
||
## Dependencies | ||
|
||
Software | Source | ||
-------------------|---------- | ||
Anaconda 3 2020.02 | [Anaconda3-2020.02-Windows-x86_64.exe](https://repo.anaconda.com/archive/Anaconda3-2020.02-Windows-x86_64.exe) | ||
Jupytext 1.4.2 | `conda install -c conda-forge jupytext` | ||
Doxygen 1.8.18 | `conda install -c conda-forge doxygen` | ||
MikTeX 2.9.6753 | `conda install -c conda-forge MikTeX` | ||
GhostScript 9.22 | `conda install -c conda-forge GhostScript` | ||
GhostScript 9.22 | `conda install -c conda-forge GhostScript` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.