Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better colors for "info" and "success" notes in the documentation and website #1893

Merged
merged 1 commit into from
Oct 6, 2022
Merged

Better colors for "info" and "success" notes in the documentation and website #1893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions docs/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,11 +261,7 @@ TAB_SIZE = 4
# commands \{ and \} for these it is advised to use the version @{ and @} or use
# a double escape (\\{ and \\})

ALIASES = \
"cb{1}=@code{\1}" \
"cpp=@code{.cpp}" \
"cmake=@code{.cmake}" \
"ce=@endcode"
ALIASES =

# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
Expand Down Expand Up @@ -2137,7 +2133,8 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = CORRADE_UNUSED=
PREDEFINED = DOXYGEN_GENERATING_OUTPUT \
CORRADE_UNUSED=

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
1 change: 1 addition & 0 deletions docs/Doxyfile-mcss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ ALIASES = \
"cpp=@code{.cpp}" \
"glsl=@code{.glsl}" \
"cmake=@code{.cmake}" \
"relativeref{2}=@ref \1::\2 \"\2\"" \
"ce=@endcode" \
"m_div{1}=@xmlonly<mcss:div xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:class=\"\1\">@endxmlonly" \
"m_enddiv=@xmlonly</mcss:div>@endxmlonly" \
Expand Down
15 changes: 15 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,18 @@ nano Doxyfile # modify it to have GENERATE_TAGFILE = bullet.tag
doxygen # it'll complain about some CHM file, ignore that
cp bullet.tag ../habitat-sim/docs/
```

### Updating the CSS theme, refreshing the compiled version of it

Make your changes to `theme.css`. Easiest is to experiment in a browser
inspector and then copy the updated colors over to the theme file. Note that
the color variables are shared by multiple places, so for example changing
colors of the warning note will also affect labels and table backgrounds.

Then, run `./build.sh` (which regenerates `theme-compiled.css`, which is
deliberately *not* tracked in Git) and verify the generated output in the
browser again.

The `theme.css` should then get synced with the `habitat-lab` and
`habitat-website` repositories so it's always possible to play with the colors
in context of one repository and sync it to the others.
2 changes: 1 addition & 1 deletion docs/m.css
Open in desktop
Submodule m.css updated 34 files
+1 −1 .editorconfig
+13 −8 CREDITS.rst
+4 −4 css/m-components.css
+4 −4 css/m-dark+documentation.compiled.css
+4 −4 css/m-dark.compiled.css
+4 −4 css/m-light+documentation.compiled.css
+4 −4 css/m-light.compiled.css
+4 −4 doc/css/page-layout.rst
+62 −7,927 doc/documentation/corrade.tag
+2 −1 doc/documentation/doxygen.rst
+1 −1 doc/documentation/python.rst
+8 −8 doc/plugins/links.rst
+1 −1 doc/themes/pelican.rst
+1 −1 doc/why.rst
+83 −34 documentation/doxygen.py
+1 −1 documentation/templates/doxygen/details-func.html
+1 −1 documentation/templates/doxygen/entry-func.html
+14 −0 documentation/test_doxygen/compound_namespace_members_in_file_scope/File.h
+14 −0 documentation/test_doxygen/compound_namespace_members_in_file_scope/File_8h.html
+10 −0 documentation/test_doxygen/compound_namespace_members_in_file_scope/namespaceNamespace.html
+1 −1 documentation/test_doxygen/contents_tagfile/index.html
+1 −1 documentation/test_doxygen/contents_tagfile/input.dox
+6 −0 documentation/test_doxygen/cpp_friends/File.h
+10 −0 documentation/test_doxygen/cpp_friends/classClass.html
+14 −0 documentation/test_doxygen/cpp_function_attributes/input.h
+22 −0 documentation/test_doxygen/cpp_function_attributes/structFoo.html
+11 −2 package/ci/circleci.yml
+2 −1 plugins/ansilexer.py
+17 −7 plugins/m/dox.py
+19 −7 plugins/m/test/dox/page.html
+16 −4 plugins/m/test/dox/page.rst
+19 −7 plugins/m/test/dox/page_css_classes.html
+28 −0 plugins/m/test/dox/stl.tag
+4 −2 plugins/m/test/test_dox.py
12 changes: 6 additions & 6 deletions docs/theme.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,10 @@

--success-color: #3bd267;
--success-link-active-color: #acecbe;
--success-filled-color: #acecbe;
--success-filled-background-color: #2a703f;
--success-filled-link-color: #3bd267;
--success-filled-link-active-color: #acecbe;
--success-filled-color: #2a703f;
--success-filled-background-color: #d9efdf;
--success-filled-link-color: #00cf3c;
--success-filled-link-active-color: #53e97d;

--warning-color: #6d7207;
--warning-link-active-color: #e9ecae;
Expand All @@ -118,8 +118,8 @@

--info-color: #2f83cc;
--info-link-active-color: #5297d7;
--info-filled-color: #a5caeb;
--info-filled-background-color: #2a4f70;
--info-filled-color: #2a4f70;
--info-filled-background-color: #d7ebfe;
--info-filled-link-color: #5297d7;
--info-filled-link-active-color: #a5caeb;

Expand Down