Skip to content

Commit

Permalink
Home: Add menu item for new top-level landing page
Browse files Browse the repository at this point in the history
It will be indexing the main docs entrypoints.

This page is special, should not necessarily be part of the content
tree, that's why it is flagged as orphaned.

The aim is to slot this page into the URL namespace as a landing page
for all the documentation based on Sphinx, straight at
https://cratedb.com/docs/.
  • Loading branch information
amotl committed Jul 4, 2024
1 parent ade4ddb commit 7a83df3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ CHANGES
Unreleased
----------
- CSS: Adjusted inner alignment being off for cards with links
- Home: Added new top-level landing page, indexing the main docs entrypoints

2024/06/27 0.33.0
-----------------
Expand Down
9 changes: 8 additions & 1 deletion src/crate/theme/rtd/crate/sidebartoc.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@

{% else %}

<!-- Home. -->
{% if project == 'CrateDB: Guide' and pagename == 'home/index' %}
<li class="navleft-item current"><a class="current-active" href="/docs/guide/home/">Docs Home</a></li>
{% else %}
<li class="navleft-item"><a href="/docs/guide/home/">Docs Home</a></li>
{% endif %}

<!-- Section A. -->
{% if project == 'CrateDB Cloud' %}
<li class="current">
Expand All @@ -19,7 +26,7 @@
<li class="navleft-item"><a href="/docs/cloud/">CrateDB Cloud</a></li>
{% endif %}

{% if project == 'CrateDB: Guide' %}
{% if project == 'CrateDB: Guide' and pagename != 'home/index' %}
<li class="current">
<a class="current-active" href="{{ pathto(master_doc) }}">Guides and Tutorials</a>
{{ toctree(maxdepth=3|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }}
Expand Down

0 comments on commit 7a83df3

Please sign in to comment.