Modify mkdocs theme #1289
Merged
Modify mkdocs theme #1289
Conversation
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
|
Hi Ashley! Can you rebase this branch to merge into improve_doc? We can then use that branch as the master for doc improvement specifically and submit PRs to that branch for later adjustments. |
5 tasks
xinyis991105
approved these changes
Mar 9, 2021
There was a problem hiding this comment.
LGTM in terms of code file changes; for some reason it doesn't render properly on my local end but it seems that #1290 which branches off of this one renders ok. I'll look more into my local end issue later.
xinyis991105
added a commit
that referenced
this pull request
May 4, 2021
* Modify mkdocs theme (#1289) * Request for institution name in the bug template (#1285) * Modify mkdocs material theme to have tabs and use autolab red Co-authored-by: Victor Huang <victorhuangwq@gmail.com> * Unify installation section in documentation (#1290) * Setup new page for installation unification * Split up ubuntu and osx installation pages * Modify installation docs structure * Change getting started to link to new installation page * Separate out commands into its own block * Change backtick code blocks to identation + colon style * Move Tango installation instructions to installation tab * Separate Tango deployment methods in docs * Improve wording on TLS/SSL, and link to Tango installation section after completing manual Autolab setup * Add minor change from SSL to TLS/SSL Co-authored-by: xtrkil <victorhuangwq@gmail.com> * Overview And Getting Started Sections for Documentation (#1299) * Setup new page for installation unification * Split up ubuntu and osx installation pages * Modify installation docs structure * Change getting started to link to new installation page * Separate out commands into its own block * Change backtick code blocks to identation + colon style * Move Tango installation instructions to installation tab * Separate Tango deployment methods in docs * Improve wording on TLS/SSL, and link to Tango installation section after completing manual Autolab setup * Add minor change from SSL to TLS/SSL * Separated overview from getting started; restructured index a little bit. * Restructure done; about to add in details for overview/introduction * Added picture for Autolab system. * Done with the initial draft for overview nad getting-started Co-authored-by: Fan Pu <zengfanpu@gmail.com> Co-authored-by: xtrkil <victorhuangwq@gmail.com> * Add information on creating root user to docs (#1304) * move initialize_user.sh from docker/ to bin/ * Update ubuntu and osx installation docs on creating initial root user step * Add init-user script * Creates and Organizes Reference Section (#1302) * Create new reference section * Add reference overview * Move vmms setup instructions from vmms api to tango overview * Updates wording * Updates wording on reference * Small fixes and rollback from rollback (#1325) * Fixed installation wrong link; did some reorganization on the part of Tango VMMS. * Replaced VMMS setup instruction. * Improve the overview section of the new documentation (#1340) * Improve Overview. * Adjust wording based on feedback. * Move CLI sections into Getting Started (#1341) * Make Reference section more catered to developers * Remove tango.md * Documentation FAQ Refinement (#1348) * Reworded FAQ to Troubleshooting. Added pointers to troubleshooting sections. * Fixed wording. * Ensure all links are valid (#1349) * Ensure all links are valid and outgoing links open in new tab * Change outgoing link in tango.md to open in new tab * Metrics docs refactoring with finalized wording (#1350) * updating docs with finalized wording * Documentation FAQ Refinement (#1348) * Reworded FAQ to Troubleshooting. Added pointers to troubleshooting sections. * Fixed wording. * Ensure all links are valid (#1349) * Ensure all links are valid and outgoing links open in new tab * Change outgoing link in tango.md to open in new tab * updating docs with finalized wording * fixing page linking Co-authored-by: xinyis991105 <54905587+xinyis991105@users.noreply.github.com> Co-authored-by: ashleyzhang <ashleyzhang@gmail.com> * Add instructions on how to setup mailing on Autolab (#1336) * Add smtp settings in production.rb and documentation * Add instruction updates for development * Added description of where config files are at * fix syntax in mkdocs Co-authored-by: ashleyzhang <ashleyzhang@gmail.com> Co-authored-by: Victor Huang <victorhuangwq@gmail.com> Co-authored-by: Fan Pu <fanpu@users.noreply.github.com> Co-authored-by: Fan Pu <zengfanpu@gmail.com> Co-authored-by: amartinez116 <31053044+amartinez116@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds customizations to the mkdocs-material theme. The main changes are to make the color scheme align with Autolab red, include top-level tabs, and integrate the table of contents on the right hand side into the left side navigation.
Motivation and Context
This is part of an ongoing effort to improve Autolab's documentation.
How Has This Been Tested?
Run
mkdocs serveto view the docs locally. Click through tabs and content to ensure that the pages work as expected.Types of changes
Checklist:
Other issues / help required
If unsure, feel free to submit first and we'll help you along.