Skip to content

docs: Add src for Doxygen documentation #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

docs: Add src for Doxygen documentation #241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28ade91
docs: Add src for Doxygen documentation
hjn0415a Feb 3, 2025
2d35b5f
Merge branch 'develop' into develop
poshul Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 3 additions & 1 deletion .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ build:
os: ubuntu-20.04
tools:
python: "3.11"
apt_packages:
- graphviz

python:
install:
- requirements: requirements.txt

formats:
- pdf
- htmlzip
- htmlzip
Comment on lines 21 to +23
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Fix YAML formatting issues.

There are formatting inconsistencies in the YAML file.

Apply these changes to maintain consistent indentation and add a newline at the end of the file:

 formats:
-    - pdf
-    - htmlzip
+  - pdf
+  - htmlzip
+
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
formats:
- pdf
- htmlzip
- htmlzip
formats:
- pdf
- htmlzip
🧰 Tools
🪛 YAMLlint (1.35.1)

[warning] 22-22: wrong indentation: expected 2 but found 4

(indentation)

[error] 23-23: no new line character at the end of file

(new-line-at-end-of-file)

7 changes: 3 additions & 4 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,19 @@
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXOPTS = -D html_dir=""
SPHINXBUILD = sphinx-build
SPHINXPROJ = openms
SOURCEDIR = docs
BUILDDIR = build
BUILDDIR = build/docs/sphinx

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)


.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
10 changes: 10 additions & 0 deletions _static/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,4 +149,14 @@ h6::before {

h6 {
counter-reset: h6;
}

/* Remove scrollbar from side menu */
.bd-sidebar {
scrollbar-width: none;
-ms-overflow-style: none;
}

.bd-sidebar::-webkit-scrollbar {
display: none;
}
Loading
Loading