Skip to content

Commit b88e11d

Browse files
Implement major improvements to API documentation formatting and navigation
Co-authored-by: nonprofittechy <7645641+nonprofittechy@users.noreply.github.com>
1 parent 20888ab commit b88e11d

23 files changed

+5150
-365
lines changed

docs/components/ALToolbox/al_income.md

Lines changed: 446 additions & 44 deletions
Large diffs are not rendered by default.

docs/components/ALToolbox/business_days.md

Lines changed: 58 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,29 @@
1+
# Table of Contents
2+
3+
* [ALToolbox.business\_days](#ALToolbox.business_days)
4+
* [standard\_holidays](#ALToolbox.business_days.standard_holidays)
5+
* [is\_business\_day](#ALToolbox.business_days.is_business_day)
6+
* [get\_next\_business\_day](#ALToolbox.business_days.get_next_business_day)
7+
* [get\_date\_after\_n\_business\_days](#ALToolbox.business_days.get_date_after_n_business_days)
8+
19
---
210
sidebar_label: business_days
311
title: ALToolbox.business_days
412
---
513

6-
#### standard\_holidays
14+
<a id="ALToolbox.business_days.standard_holidays"></a>
15+
16+
#### standard\_holidays(year, country="US", subdiv="MA", add\_holidays: Optional[Mapping] = None, remove\_holidays: Optional[Iterable[str]] = None)
17+
18+
```python
19+
def standard_holidays(
20+
year,
21+
country="US",
22+
subdiv="MA",
23+
add_holidays: Optional[Mapping] = None,
24+
remove_holidays: Optional[Iterable[str]] = None
25+
) -> holidays.HolidayBase
26+
```
727

828
Get all holidays in the specified year, country, and state (or other subdivision).
929
Note that this draws on the &quot;holidays&quot; package which may deviate slightly from
@@ -24,7 +44,17 @@ the keys are datetime.date objects.
2444
\}
2545
```
2646
27-
#### is\_business\_day
47+
<a id="ALToolbox.business_days.is_business_day"></a>
48+
49+
#### is\_business\_day(date: Union[str, DADateTime], country="US", subdiv="MA", add\_holidays: Optional[Mapping] = None, remove\_holidays: Optional[Iterable[str]] = None)
50+
51+
```python
52+
def is_business_day(date: Union[str, DADateTime],
53+
country="US",
54+
subdiv="MA",
55+
add_holidays: Optional[Mapping] = None,
56+
remove_holidays: Optional[Iterable[str]] = None) -> bool
57+
```
2858

2959
Returns true if and only if the specified date is a business day (i.e., not a holiday)
3060
in the specified jurisdiction. Business days are considered to be:
@@ -37,7 +67,19 @@ in the specified jurisdiction. Business days are considered to be:
3767
assert(is_business_day("2023-03-26") == False)
3868
```
3969

40-
#### get\_next\_business\_day
70+
<a id="ALToolbox.business_days.get_next_business_day"></a>
71+
72+
#### get\_next\_business\_day(start\_date: Union[str, DADateTime], wait\_n\_days=1, country="US", subdiv="MA", add\_holidays: Optional[Mapping] = None, remove\_holidays: Optional[Iterable[str]] = None)
73+
74+
```python
75+
def get_next_business_day(
76+
start_date: Union[str, DADateTime],
77+
wait_n_days=1,
78+
country="US",
79+
subdiv="MA",
80+
add_holidays: Optional[Mapping] = None,
81+
remove_holidays: Optional[Iterable[str]] = None) -> DADateTime
82+
```
4183

4284
Returns the first day AFTER the specified start date that is
4385
not a federal or state holiday, Saturday or Sunday. Optionally,
@@ -61,7 +103,19 @@ https://github.com/dr-prodigy/python-holidays/tree/master/holidays/countries
61103
will add those holidays to be considered
62104
- `remove_holidays` - the list of date strings (&quot;12/25&quot;) of dates that are no longer holidays
63105

64-
#### get\_date\_after\_n\_business\_days
106+
<a id="ALToolbox.business_days.get_date_after_n_business_days"></a>
107+
108+
#### get\_date\_after\_n\_business\_days(start\_date: Union[str, DADateTime], wait\_n\_days=1, country="US", subdiv="MA", add\_holidays: Optional[Mapping] = None, remove\_holidays: Optional[Iterable[str]] = None)
109+
110+
```python
111+
def get_date_after_n_business_days(
112+
start_date: Union[str, DADateTime],
113+
wait_n_days=1,
114+
country="US",
115+
subdiv="MA",
116+
add_holidays: Optional[Mapping] = None,
117+
remove_holidays: Optional[Iterable[str]] = None) -> DADateTime
118+
```
65119

66120
Returns a time period which contains a minimum of `n` business days.
67121

docs/components/ALToolbox/copy_button.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,28 @@
1+
# Table of Contents
2+
3+
* [ALToolbox.copy\_button](#ALToolbox.copy_button)
4+
* [copy\_button\_html](#ALToolbox.copy_button.copy_button_html)
5+
16
---
27
sidebar_label: copy_button
38
title: ALToolbox.copy_button
49
---
510

6-
#### copy\_button\_html
11+
<a id="ALToolbox.copy_button.copy_button_html"></a>
12+
13+
#### copy\_button\_html(text\_to\_copy: str, text\_before: str = "", label: str = "Copy", tooltip\_inert\_text: str = "Copy to clipboard", tooltip\_copied\_text: str = "Copied!", copy\_template\_block: bool = False, scroll\_class: str = "", style\_class: str = "", adjust\_height: str = "")
14+
15+
```python
16+
def copy_button_html(text_to_copy: str,
17+
text_before: str = "",
18+
label: str = "Copy",
19+
tooltip_inert_text: str = "Copy to clipboard",
20+
tooltip_copied_text: str = "Copied!",
21+
copy_template_block: bool = False,
22+
scroll_class: str = "",
23+
style_class: str = "",
24+
adjust_height: str = "") -> str
25+
```
726

827
Return the html for a button that will let a user copy the given text
928

0 commit comments

Comments
 (0)