Skip to content

Commit d0e7abb

Browse files
committed
cleanup navigation layout
1 parent 052e589 commit d0e7abb

File tree

3 files changed

+31
-2
lines changed

3 files changed

+31
-2
lines changed

docs/mkdocs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ theme:
2424
name: Switch to light mode
2525

2626
nav:
27-
- ⬅ Home: https://www.datajoint.org/
2827
- Element Array Ephys: /getting_started/
2928
- Getting Started:
3029
- Installation: getting_started/index.md

docs/overrides/main.html

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{% extends "base.html" %}
2+
3+
{% block site_nav %}
4+
{% set class = "md-nav md-nav--primary" %}
5+
{% if "navigation.tabs" in features %}
6+
{% set class = class ~ " md-nav--lifted" %}
7+
{% endif %}
8+
{% if "toc.integrate" in features %}
9+
{% set class = class ~ " md-nav--integrated" %}
10+
{% endif %}
11+
<nav class="{{ class }}" aria-label="{{ lang.t('nav.title') }}" data-md-level="0">
12+
<label class="md-nav__title" for="__drawer">
13+
<a href="https://www.datajoint.org/" title="DataJoint">
14+
⬅ Home
15+
</a>
16+
</label>
17+
{% if config.repo_url %}
18+
<div class="md-nav__source">
19+
{% include "partials/source.html" %}
20+
</div>
21+
{% endif %}
22+
<ul class="md-nav__list" data-md-scrollfix>
23+
{% for nav_item in nav %}
24+
{% set path = "__nav_" ~ loop.index %}
25+
{% set level = 1 %}
26+
{% include "partials/nav-item.html" %}
27+
{% endfor %}
28+
</ul>
29+
</nav>
30+
{% endblock %}

docs/src/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Docstrings guide](https://realpython.com/python-project-documentation-with-mkdocs/#step-3-write-and-format-your-docstrings)
1+
[Mkdocstrings Documentation](https://mkdocstrings.github.io/usage/)
22

33
[Google-Style format](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
44

0 commit comments

Comments
 (0)