Skip to content
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

Jump to bottom

Documentation Changes #57

Merged
merged 14 commits into from
Jun 13, 2024
Merged

Documentation Changes #57

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
e56ff27
unicode?
justin13601 Jun 12, 2024
b7666b7
DUC looks better I think
justin13601 Jun 12, 2024
c9409bf
Remove lines
justin13601 Jun 12, 2024
59e2332
Docs
justin13601 Jun 13, 2024
765fffe
Reorg titles
justin13601 Jun 13, 2024
a009eaf
Add new title
justin13601 Jun 13, 2024
81907db
Remove eICU tasks and change title in technical
justin13601 Jun 13, 2024
7509407
Docstring with subpackage?
justin13601 Jun 13, 2024
e4c80ec
profiling numbers except memory
justin13601 Jun 13, 2024
2092759
Update init config docstring
justin13601 Jun 13, 2024
bd96458
Changes
justin13601 Jun 13, 2024
40c4ed0
Reformat init
justin13601 Jun 13, 2024
2500db7
Add memory
justin13601 Jun 13, 2024
6f7a4d4
Small fixes
justin13601 Jun 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 28 additions & 28 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,40 +321,40 @@ def ensure_pandoc_installed(_):


# -- Options for LaTeX output

latex_engine = "xelatex"
latex_elements = { # type: ignore
# The paper size ("letterpaper" or "a4paper").
"papersize": "letterpaper",
# The font size ("10pt", "11pt" or "12pt").
"pointsize": "10pt",
# Additional stuff for the LaTeX preamble.
"preamble": "\n".join(
[
r"\usepackage{svg}",
r"\DeclareUnicodeCharacter{2501}{-}",
r"\DeclareUnicodeCharacter{2503}{|}",
r"\DeclareUnicodeCharacter{2500}{-}",
r"\DeclareUnicodeCharacter{2550}{-}",
r"\DeclareUnicodeCharacter{2517}{+}",
r"\DeclareUnicodeCharacter{2518}{+}",
r"\DeclareUnicodeCharacter{2534}{+}",
r"\DeclareUnicodeCharacter{250C}{+}",
r"\DeclareUnicodeCharacter{252C}{+}",
r"\DeclareUnicodeCharacter{2510}{+}",
r"\DeclareUnicodeCharacter{2502}{|}",
r"\DeclareUnicodeCharacter{2506}{|}",
r"\DeclareUnicodeCharacter{2561}{|}",
r"\DeclareUnicodeCharacter{256A}{|}",
r"\DeclareUnicodeCharacter{2523}{|}",
r"\DeclareUnicodeCharacter{03BC}{\ensuremath{\mu}}",
r"\DeclareUnicodeCharacter{255E}{|}",
r"\DeclareUnicodeCharacter{255F}{+}",
r"\DeclareUnicodeCharacter{254E}{|}",
r"\DeclareUnicodeCharacter{257C}{-}",
r"\DeclareUnicodeCharacter{257E}{-}",
r"\DeclareUnicodeCharacter{2559}{+}",
]
),
# "preamble": "\n".join(
# [
# r"\usepackage{svg}",
# r"\DeclareUnicodeCharacter{2501}{-}",
# r"\DeclareUnicodeCharacter{2503}{|}",
# r"\DeclareUnicodeCharacter{2500}{-}",
# r"\DeclareUnicodeCharacter{2550}{-}",
# r"\DeclareUnicodeCharacter{2517}{+}",
# r"\DeclareUnicodeCharacter{2518}{+}",
# r"\DeclareUnicodeCharacter{2534}{+}",
# r"\DeclareUnicodeCharacter{250C}{+}",
# r"\DeclareUnicodeCharacter{252C}{+}",
# r"\DeclareUnicodeCharacter{2510}{+}",
# r"\DeclareUnicodeCharacter{2502}{|}",
# r"\DeclareUnicodeCharacter{2506}{|}",
# r"\DeclareUnicodeCharacter{2561}{|}",
# r"\DeclareUnicodeCharacter{256A}{|}",
# r"\DeclareUnicodeCharacter{2523}{|}",
# r"\DeclareUnicodeCharacter{03BC}{\ensuremath{\mu}}",
# r"\DeclareUnicodeCharacter{255E}{|}",
# r"\DeclareUnicodeCharacter{255F}{+}",
# r"\DeclareUnicodeCharacter{254E}{|}",
# r"\DeclareUnicodeCharacter{257C}{-}",
# r"\DeclareUnicodeCharacter{257E}{-}",
# r"\DeclareUnicodeCharacter{2559}{+}",
# ]
# ),
Copy link
Contributor

Choose a reason for hiding this comment

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

The large block of LaTeX preamble settings has been commented out. If this is intentional for simplification, consider removing it entirely to clean up the configuration file.

-    # "preamble": "\n".join(
-    #     [
-    #         r"\usepackage{svg}",
-    #         ...
-    #         r"\DeclareUnicodeCharacter{2559}{+}",
-    #     ]
-    # ),
+    # Preamble settings removed for simplification.
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
# "preamble": "\n".join(
# [
# r"\usepackage{svg}",
# r"\DeclareUnicodeCharacter{2501}{-}",
# r"\DeclareUnicodeCharacter{2503}{|}",
# r"\DeclareUnicodeCharacter{2500}{-}",
# r"\DeclareUnicodeCharacter{2550}{-}",
# r"\DeclareUnicodeCharacter{2517}{+}",
# r"\DeclareUnicodeCharacter{2518}{+}",
# r"\DeclareUnicodeCharacter{2534}{+}",
# r"\DeclareUnicodeCharacter{250C}{+}",
# r"\DeclareUnicodeCharacter{252C}{+}",
# r"\DeclareUnicodeCharacter{2510}{+}",
# r"\DeclareUnicodeCharacter{2502}{|}",
# r"\DeclareUnicodeCharacter{2506}{|}",
# r"\DeclareUnicodeCharacter{2561}{|}",
# r"\DeclareUnicodeCharacter{256A}{|}",
# r"\DeclareUnicodeCharacter{2523}{|}",
# r"\DeclareUnicodeCharacter{03BC}{\ensuremath{\mu}}",
# r"\DeclareUnicodeCharacter{255E}{|}",
# r"\DeclareUnicodeCharacter{255F}{+}",
# r"\DeclareUnicodeCharacter{254E}{|}",
# r"\DeclareUnicodeCharacter{257C}{-}",
# r"\DeclareUnicodeCharacter{257E}{-}",
# r"\DeclareUnicodeCharacter{2559}{+}",
# ]
# ),
# Preamble settings removed for simplification.

}

# Grouping the document tree into LaTeX files. List of tuples
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Sample Data Tutorial <notebooks/tutorial>
Predicates DataFrame <notebooks/predicates>
Configuration Language <configuration>
Algorithm & Terminology <terminology>
Profiling <profiling>
Computational Profiling <profiling>
Module API Reference <api/modules>
License <license>
```
Expand Down
4 changes: 3 additions & 1 deletion docs/source/profiling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# TODO - include the table from supplementary
# Computational Profiling

TODO - include the table from supplementary
Loading