Skip to content

Commit

Permalink
CLI man page event handler implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
Lilferrit committed Jul 8, 2024
1 parent 6d2db26 commit 58375ea
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 36 deletions.
25 changes: 0 additions & 25 deletions docs/_static/js/cli-page.js

This file was deleted.

6 changes: 0 additions & 6 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,3 @@ For Casanovo installation instructions, see the :doc:`Getting Started <getting_s
:prog: casanovo
:nested: full
:commands: configure, evaluate, sequence, train, version

..
This is just a random sequence of letters so the custom javascript can
ensure it is running on the correct page before running any filtering
operations
pfqnhktptyfdeomqabhq
11 changes: 6 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath("."))
import os
import sys

sys.path.insert(0, os.path.abspath("."))


# -- Project information -----------------------------------------------------
Expand All @@ -30,7 +31,7 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named "sphinx.ext.*") or your custom
# ones.
extensions = ["myst_parser", "sphinx_click"]
extensions = ["myst_parser", "sphinx_click", "sphinx_click_handlers"]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand All @@ -57,7 +58,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
# html_static_path = ["_static"]
html_theme_options = {"repository_url": "https//github.com/Noble-Lab/casanovo"}

html_js_files = [
Expand Down
9 changes: 9 additions & 0 deletions docs/sphinx_click_handlers.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
def process_description(app, ctx, lines):
if ctx.command.name == "main":
del lines[:3]

print(lines)


def setup(app):
app.connect("sphinx-click-process-description", process_description)

0 comments on commit 58375ea

Please sign in to comment.