Skip to content

Commit 89d88fa

Browse files
jmgatejmgate
committed
docs: Update links
Update various links after moving `shell-logger` out onto GitHub.
1 parent b6de407 commit 89d88fa

File tree

7 files changed

+60
-45
lines changed

7 files changed

+60
-45
lines changed

‎doc/source/abstract_method.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,3 @@ AbstractMethod
22
==============
33

44
.. autoexception:: shell_logger.abstract_method.AbstractMethod
5-
:noindex:

‎doc/source/html_utilities.rst

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,38 @@ HTML Utilities
44
The following are a number of utility functions used to generate the HTML log
55
file produced by :class:`ShellLogger`.
66

7-
.. automodule:: shell_logger.html_utilities
8-
:noindex:
7+
.. autofunction:: shell_logger.html_utilities.append_html
8+
.. autofunction:: shell_logger.html_utilities.child_logger_card
9+
.. autofunction:: shell_logger.html_utilities.child_logger_card_html
10+
.. autofunction:: shell_logger.html_utilities.closing_html_text
11+
.. autofunction:: shell_logger.html_utilities.command_card
12+
.. autofunction:: shell_logger.html_utilities.command_card_html
13+
.. autofunction:: shell_logger.html_utilities.command_detail
14+
.. autofunction:: shell_logger.html_utilities.command_detail_list
15+
.. autofunction:: shell_logger.html_utilities.diagnostics_card
16+
.. autofunction:: shell_logger.html_utilities.disk_time_series_plot
17+
.. autofunction:: shell_logger.html_utilities.embed_html
18+
.. autofunction:: shell_logger.html_utilities.embed_script
19+
.. autofunction:: shell_logger.html_utilities.embed_style
20+
.. autofunction:: shell_logger.html_utilities.fixed_width
21+
.. autofunction:: shell_logger.html_utilities.flatten
22+
.. autofunction:: shell_logger.html_utilities.get_human_time
23+
.. autofunction:: shell_logger.html_utilities.html_encode
24+
.. autofunction:: shell_logger.html_utilities.html_header
25+
.. autofunction:: shell_logger.html_utilities.html_message_card
26+
.. autofunction:: shell_logger.html_utilities.load_template
27+
.. autofunction:: shell_logger.html_utilities.message_card
28+
.. autofunction:: shell_logger.html_utilities.nested_simplenamespace_to_dict
29+
.. autofunction:: shell_logger.html_utilities.opening_html_text
30+
.. autofunction:: shell_logger.html_utilities.output_block
31+
.. autofunction:: shell_logger.html_utilities.output_block_card
32+
.. autofunction:: shell_logger.html_utilities.output_block_html
33+
.. autofunction:: shell_logger.html_utilities.output_line_html
34+
.. autofunction:: shell_logger.html_utilities.parent_logger_card_html
35+
.. autofunction:: shell_logger.html_utilities.sgr_24bit_color_to_html
36+
.. autofunction:: shell_logger.html_utilities.sgr_4bit_color_and_style_to_html
37+
.. autofunction:: shell_logger.html_utilities.sgr_8bit_color_to_html
38+
.. autofunction:: shell_logger.html_utilities.sgr_to_html
39+
.. autofunction:: shell_logger.html_utilities.split_template
40+
.. autofunction:: shell_logger.html_utilities.stat_chart_card
41+
.. autofunction:: shell_logger.html_utilities.time_series_plot

‎doc/source/index.rst

Lines changed: 24 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,18 @@ while logging various metadata, statistics, and trace information. Any time
1919
you're tempted to write your own wrapper around things like
2020
:class:`subprocess.Popen` or :func:`subprocess.run`, consider using
2121
:func:`ShellLogger.log` instead. If you're familiar with `the Unix script
22-
command <https://man7.org/linux/man-pages/man1/script.1.html>`_, this is
23-
similar in principle, but with substantially more functionality. If you're
24-
familiar with `Python's logging module
25-
<https://docs.python.org/3/library/logging.html>`_, the motivation is similar,
26-
but this intends to capture what's happening *in the shell* rather than in
27-
Python itself.
22+
command`_, this is similar in principle, but with substantially more
23+
functionality. If you're familiar with `Python's logging module`_, the
24+
motivation is similar, but this intends to capture what's happening *in the
25+
shell* rather than in Python itself.
2826

29-
The following talk from the `US-RSE Virtual Workshop 2021
30-
<https://us-rse.org/virtual-workshop-2021/>`_ illustrates the module's
31-
functionality.
27+
.. _the Unix script command: https://man7.org/linux/man-pages/man1/script.1.html
28+
.. _Python's logging module: https://docs.python.org/3/library/logging.html
29+
30+
The following talk from the `US-RSE Virtual Workshop 2021`_ illustrates the
31+
module's functionality.
32+
33+
.. _US-RSE Virtual Workshop 2021: https://us-rse.org/virtual-workshop-2021/
3234

3335
.. raw:: html
3436

@@ -53,11 +55,12 @@ functionality.
5355
Where to Get shell-logger
5456
-------------------------
5557

56-
The source repository for this module can be found `here
57-
<https://internal.gitlab.server/ShellLogger/ShellLogger>`_. See the project's
58-
`README.md
59-
<https://internal.gitlab.server/ShellLogger/ShellLogger/-/blob/master/README.md>`_
60-
for details on how to clone, install, and otherwise interact with the project.
58+
The source repository for this module can be found `on GitHub`_. See the
59+
project's `README`_ for details on how to clone, install, and otherwise
60+
interact with the project.
61+
62+
.. _on GitHub: https://github.com/sandialabs/shell-logger
63+
.. _README: https://github.com/sandialabs/shell-logger/blob/master/README.md
6164

6265
Using shell-logger
6366
------------------
@@ -105,17 +108,16 @@ the following:
105108
.. literalinclude:: ../../example/hello_world_html.py
106109
:language: python
107110
:linenos:
111+
:lines: 11-
108112
:caption: ``example/hello_world_html.py``
109113

110114
Running the script yields
111115

112116
.. code-block::
113117
114118
This example demonstrates logging information solely to the HTML log file.
115-
Open /Users/jmgate/workspace/shell-logger/example/log_hello_world_html/2021-09-22_14.56.42.558599_szt68acx/Hello_ShellLogger.html to view the log.
119+
Open <path-to-example-dir>/log_hello_world_html/<timestamp>_<unique-str>/Hello_ShellLogger.html to view the log.
116120
117-
You can view the generated HTML log file `here
118-
<http://shelllogger.internal.gitlab.pages/shell-logger/example/Hello_World_HTML.html>`__.
119121
When you open that file, you'll see something like
120122

121123
.. image:: images/html_log.png
@@ -175,12 +177,10 @@ highlighted lines below.
175177
.. literalinclude:: ../../example/hello_world_html_and_console.py
176178
:language: python
177179
:linenos:
178-
:emphasize-lines: 11, 13
180+
:lines: 11-
181+
:emphasize-lines: 15-16, 22-23
179182
:caption: ``example/hello_world_html_and_console.py``
180183

181-
You can view the generated HTML log file `here
182-
<http://shelllogger.internal.gitlab.pages/shell-logger/example/Hello_World_HTML_and_Console.html>`__.
183-
184184
Example 3: Collecting Statistics
185185
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
186186

@@ -191,12 +191,10 @@ and **Example 1** are the highlighted lines below.
191191
.. literalinclude:: ../../example/hello_world_html_with_stats.py
192192
:language: python
193193
:linenos:
194-
:emphasize-lines: 12, 14
194+
:lines: 11-
195+
:emphasize-lines: 16, 22
195196
:caption: ``example/hello_world_html_with_stats.py``
196197

197-
You can view the generated HTML log file `here
198-
<http://shelllogger.internal.gitlab.pages/shell-logger/example/Hello_World_HTML_with_Stats.html>`__.
199-
200198
Example 4: Building a Code
201199
^^^^^^^^^^^^^^^^^^^^^^^^^^^
202200

@@ -215,11 +213,9 @@ The equivalent Python script using ``shell-logger`` is the following:
215213
.. literalinclude:: ../../example/build_flex.py
216214
:language: python
217215
:linenos:
216+
:lines: 11-
218217
:caption: ``example/build_flex.py``
219218

220-
You can view the generated HTML log file `here
221-
<http://shelllogger.internal.gitlab.pages/shell-logger/example/Build_Flex.html>`__.
222-
223219
More Details
224220
------------
225221

‎doc/source/shell.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
Shell
22
=====
33

4-
.. automodule:: shell_logger.shell
5-
:noindex:
4+
.. autoclass:: shell_logger.shell.Shell

‎doc/source/shell_logger.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,15 @@ ShellLogger
22
===========
33

44
.. autoclass:: shell_logger.ShellLogger
5-
:noindex:
65

76
JSON Serialization
87
------------------
98

109
.. autoclass:: shell_logger.ShellLoggerDecoder
11-
:noindex:
1210

1311
.. todo::
1412

1513
Figure out why the documentation below is pulling in the docstring for the
1614
base class as well.
1715

1816
.. autoclass:: shell_logger.ShellLoggerEncoder
19-
:noindex:

‎doc/source/stats_collector.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,20 @@ StatsCollector
22
==============
33

44
.. autoclass:: shell_logger.stats_collector.StatsCollector
5-
:noindex:
65

76
.. automethod:: shell_logger.stats_collector::stats_collectors
8-
:noindex:
97

108
DiskStatsCollector
119
------------------
1210

1311
.. autoclass:: shell_logger.stats_collector.DiskStatsCollector
14-
:noindex:
1512

1613
CPUStatsCollector
1714
-----------------
1815

1916
.. autoclass:: shell_logger.stats_collector.CPUStatsCollector
20-
:noindex:
2117

2218
MemoryStatsCollector
2319
--------------------
2420

2521
.. autoclass:: shell_logger.stats_collector.MemoryStatsCollector
26-
:noindex:

‎doc/source/trace.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,15 @@ Trace
22
=====
33

44
.. autoclass:: shell_logger.trace.Trace
5-
:noindex:
65

76
.. automethod:: shell_logger.trace::trace_collector
8-
:noindex:
97

108
STrace
119
------
1210

1311
.. autoclass:: shell_logger.trace.STrace
14-
:noindex:
1512

1613
LTrace
1714
------
1815

1916
.. autoclass:: shell_logger.trace.LTrace
20-
:noindex:

0 commit comments

Comments
 (0)