Skip to content

Commit

Permalink
docs: switch to mds
Browse files Browse the repository at this point in the history
  • Loading branch information
js2264 committed Sep 9, 2024
1 parent afc008b commit 31f780d
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 45 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,6 @@ _scratch/
.vscode
example.py
*.momics/
benchmark.py
.tox
benchmark.py
/*py
10 changes: 10 additions & 0 deletions docs/source/_static/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/source/cli/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ CLI

.. click:: momics.cli.create:create
:prog: momics create
:show-nested:
:nested: full

.. click:: momics.cli.add:add
:prog: momics add
:nested: full

.. click:: momics.cli.query:query
:prog: momics query
:show-nested:
:nested: full

.. click:: momics.cli.ls:ls
:prog: momics ls
:show-nested:
:nested: full
9 changes: 1 addition & 8 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
info = metadata("momics")
project = info["Name"]
author = "Jacques Serizay"
copyright = f"2023-{datetime.now():%Y}, {author}."
copyright = f"2023-{datetime.now():%Y}, {author}"
release = info["Version"]
version = release.rsplit(".", maxsplit=1)[0]

Expand Down Expand Up @@ -84,13 +84,6 @@
"show_toc_level": 2,
"footer_start": ["copyright"],
"footer_center": ["sphinx-version"],
"secondary_sidebar_items": {
"**/*": ["page-toc", "edit-this-page", "sourcelink"],
"examples/no-sidebar": [],
},
"pygments_light_style": "a11y-high-contrast-light",
"pygments_dark_style": "a11y-high-contrast-dark",
"back_to_top_button": False,
}
html_context = {
"github_url": "https://github.com/js2264/momics/",
Expand Down
5 changes: 0 additions & 5 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@
html_theme.sidebar_secondary.remove: true
---

<!-- momics documentation master file, created by
sphinx-quickstart on Mon Jul 29 11:05:32 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. -->

# momics

`momics` is a Python support library for .momics files.
Expand Down
26 changes: 0 additions & 26 deletions docs/source/index.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/source/user_guide/api.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Python API

See the [API reference](../api/index) for more information.
See the [full API reference](../api/index) for more information.

2 changes: 1 addition & 1 deletion docs/source/user_guide/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

The `momics` package includes command-line tools for creating, querying and manipulating `.momics` files.

See the [CLI reference](../cli/index) for more information.
See the [full CLI reference](../cli/index) for more information.

0 comments on commit 31f780d

Please sign in to comment.