Skip to content

Commit

Permalink
Update docs theme & deps (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
justend29 authored Jul 7, 2024
1 parent 4959592 commit 036c160
Show file tree
Hide file tree
Showing 8 changed files with 44 additions and 36 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
cmake_minimum_required(VERSION 3.24)
project(
jgd-cmake-modules
VERSION 3.4.2
VERSION 3.4.3
DESCRIPTION "CMake library for standardized CMake projects for JGD"
HOMEPAGE_URL "https://jgd-solutions.github.io/jgd-cmake-modules/"
LANGUAGES NONE)
Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ Checkout the full [documentation](https://jgd-solutions.github.io/jgd-cmake-modu
/>
</p>

Examples
--------
## Examples

This project uses its own modules, and acts as its own example!

Expand Down
2 changes: 1 addition & 1 deletion docs/build_docs_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ activated or JCM may not be able to find Sphinx.
.. code-block:: bash
cmake -B <build-dir> -D JCM_ENABLE_DOCS=ON ... # manually
cmake --preset docs-ninja # using preset
cmake --preset docs-ninja # using preset
Build Docs
~~~~~~~~~~
Expand Down
14 changes: 12 additions & 2 deletions docs/cmake_command_tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ All default build targets from :ref:`configuring <configuringcmake>` can be buil
cmake --build <build-dir>
Specific targets can be individually built with:
Specific targets can be individually built using the flag :code:`target`:

.. code-block:: bash
Expand All @@ -108,7 +108,7 @@ Specific targets can be individually built with:
For multi-configuration generators (Ninja Multi-Config, MSVC), those that correspond to
build-systems which support multiple build-types in a single build-directory, add the
:code:`--config flag` to build commands:
:code:`--config` flag to build commands:

.. code-block:: bash
Expand All @@ -119,6 +119,16 @@ build-systems which support multiple build-types in a single build-directory, ad

All of the available targets can be listed with :code:`cmake --build <build-dir> --target help`

Deleting build artifacts from a build directory, also known as *cleaning*, is useful to subsequently
build without relying on any previous artifacts. CMake always generates a `clean` target that can be
"built" to explicitly clean, or the :code:`--clean-first` flag can be provided with :code:`--build`,
to clean and build in one step:

.. code-block:: bash
cmake --build <build-dir> --target clean # only clean
cmake --build <build-dir> --clean-first # clean, then build
Installing
~~~~~~~~~~

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py.in
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "sphinx_rtd_theme"
html_theme = "furo"
html_use_index = True
html_domain_indices = True
html_context = {
Expand Down
4 changes: 2 additions & 2 deletions jgd-cmake-modules/JcmAddOption.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -431,12 +431,12 @@ Examples
DEFAULT_OFF_COMPONENTS "extra"
OUT_COMPONENTS enabled_components
MISSING_DEPENDENCY_ACTION "ENABLE"
COMPONENT_DEPENDENCIES_JSON [[
COMPONENT_DEPENDENCIES_JSON [=[
{
"extra": [ "io", "core" ],
"io": [ "core" ]
}
]])
]=])
--------------------------------------------------------------------------
Expand Down
51 changes: 25 additions & 26 deletions sphinx-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,29 +1,28 @@
alabaster==0.7.13
Babel==2.12.1
certifi==2022.12.7
charset-normalizer==3.1.0
docutils==0.17.1
idna==3.4
alabaster==0.7.16
Babel==2.15.0
beautifulsoup4==4.12.3
certifi==2024.7.4
charset-normalizer==3.3.2
docutils==0.21.2
furo==2024.5.6
idna==3.7
imagesize==1.4.1
Jinja2==3.1.2
MarkupSafe==2.1.2
packaging==23.0
Pygments==2.14.0
pytz==2022.7.1
requests==2.28.2
Jinja2==3.1.4
MarkupSafe==2.1.5
packaging==24.1
Pygments==2.18.0
requests==2.32.3
snowballstemmer==2.2.0
Sphinx==5.3.0
sphinx-rtd-theme==1.1.0
sphinx_collapse==0.1.2
sphinxcontrib-applehelp==1.0.4
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.1
sphinxcontrib-jquery==4.1
soupsieve==2.5
Sphinx==7.3.7
sphinx-basic-ng==1.0.0b2
sphinx_collapse==0.1.3
sphinxcontrib-applehelp==1.0.8
sphinxcontrib-devhelp==1.0.6
sphinxcontrib-htmlhelp==2.0.5
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-moderncmakedomain==3.25.0
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
sphinxnotes-strike==1.2
style==1.1.0
update==0.0.1
urllib3==1.26.15
sphinxcontrib-moderncmakedomain==3.29.0
sphinxcontrib-qthelp==1.0.7
sphinxcontrib-serializinghtml==1.1.10
sphinxnotes-strike==1.2.1
urllib3==2.2.2
2 changes: 1 addition & 1 deletion vcpkg.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jgd-cmake-modules",
"version": "3.4.2",
"version": "3.4.3",
"description": "CMake library for standardized CMake projects for JGD",
"homepage": "https://jgd-solutions.github.io/jgd-cmake-modules/",
"dependencies": []
Expand Down

0 comments on commit 036c160

Please sign in to comment.