Skip to content

Commit

Permalink
More documentation cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
jesper-friis committed Oct 28, 2024
1 parent 06342a9 commit 37d1671
Show file tree
Hide file tree
Showing 5 changed files with 211 additions and 136 deletions.
14 changes: 13 additions & 1 deletion doc/conf.py.in
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ extensions = [
"sphinx.ext.napoleon", # API ref Google and NumPy style
"sphinx.ext.viewcode",
"sphinxcontrib.plantuml", # PlantUml
#"sphinx_toggleprompt", # Add button for show/hide example prompts
"sphinx_toggleprompt", # Add button for show/hide example prompts
"sphinx_copybutton", # Copy button for codeblocks
"sphinx_design", # Create panels in a grid layout or as drop-downs and more
]
Expand Down Expand Up @@ -186,3 +186,15 @@ def autoapi_prepare_jinja_env(jinja_env: "Environment") -> None:
jinja_env.filters["remove_plugin_path"] = lambda name: ".".join(
name.split(".")[1:]
) if name.split(".")[0] in dlite_share_plugins else name



def skip_dlite_dlite_members(app, what, name, obj, skip, options):
"""Skip class and function whos names contains 'dlite.dlite.'."""
if "dlite.dlite." in name:
return True
return None


def setup(sphinx):
sphinx.connect("autoapi-skip-member", skip_dlite_dlite_members)
2 changes: 1 addition & 1 deletion doc/getting_started/build/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Using [Visual Studio Code] (VS Code) it is possible to do development on the sys

1. Download and install [Visual Studio Code].
2. Install the extension **Remote Development**.
3. [Clone DLite](#installing-from-source)
3. [Clone DLite](#build-from-source)
4. Open the DLite folder with VS Code.
5. Start VS Code, run the _Remote-Containers: Open Folder in Container..._ command from the Command Palette (F1) or quick actions Status bar item.
This will build the container and restart VS Code in it.
Expand Down
Loading

0 comments on commit 37d1671

Please sign in to comment.