Skip to content

Commit

Permalink
Merge pull request #93 from nunobrum/doc_improvements-2
Browse files Browse the repository at this point in the history
doc: repair broken links and simplify class names
  • Loading branch information
nunobrum authored Sep 15, 2024
2 parents 7641d47 + 65587f2 commit c3a424e
Show file tree
Hide file tree
Showing 12 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion doc/classes/asc_editor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ AscEditor

Class used for manipulating LTSpice asc files.

.. autoclass:: spicelib.editor.asc_editor.AscEditor
.. autoclass:: spicelib.AscEditor
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion doc/classes/qsch_editor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ QschEditor

Class used for manipulating QSPICE qsch files.

.. autoclass:: spicelib.editor.qsch_editor.QschEditor
.. autoclass:: spicelib.QschEditor
:members:
:undoc-members:
:show-inheritance:
3 changes: 1 addition & 2 deletions doc/classes/raw_classes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ Raw and Log File Classes
:maxdepth: 4

raw_read
raw_write
trace
logreader
raw_write
write_trace

2 changes: 1 addition & 1 deletion doc/classes/raw_read.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
RawRead
=======

.. autoclass:: spicelib.raw.raw_read.RawRead
.. autoclass:: spicelib.RawRead
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion doc/classes/raw_write.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
RawWrite
========

.. autoclass:: spicelib.raw.raw_write.RawWrite
.. autoclass:: spicelib.RawWrite
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion doc/classes/spice_circuit.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
SpiceCircuit
============

.. autoclass:: spicelib.editor.spice_editor.SpiceCircuit
.. autoclass:: spicelib.SpiceCircuit
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion doc/classes/spice_editor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ SpiceEditor

Class used for manipulating SPICE netlists. Inherits from SpiceCircuit.

.. autoclass:: spicelib.editor.spice_editor.SpiceEditor
.. autoclass:: spicelib.SpiceEditor
:members:
:undoc-members:
:show-inheritance:
9 changes: 7 additions & 2 deletions doc/classes/trace.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
RawRead Trace
=============
Axis, Trace and TraceRead
=========================

.. autoclass:: spicelib.raw.raw_classes.Axis
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: spicelib.Trace
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: spicelib.raw.raw_classes.TraceRead
:members:
:undoc-members:
Expand Down
7 changes: 0 additions & 7 deletions doc/classes/write_trace.rst

This file was deleted.

4 changes: 2 additions & 2 deletions doc/modules/read_netlist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -106,5 +106,5 @@ Example 4: Updating components inside a subcircuit
See the class documentation for more details :

* :py:class:`spicelib.SpiceEditor`
* :py:class:`spicelib.SpiceCircuit`
- :py:class:`spicelib.SpiceEditor`
- :py:class:`spicelib.SpiceCircuit`
9 changes: 6 additions & 3 deletions doc/modules/read_rawfiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ directory as the raw file in order to obtain the STEP information.
You can get a list of all trace names using the ``get_trace_names()`` method.

Use method ``get_trace()`` to get the trace data, which consists of values for 1 or more simulation steps.
It will return a :py:class:`spicelib.raw_classes.Trace` object. Use this object's ``get_wave()`` method to get
It will return a :py:class:`spicelib.Trace` object. Use this object's ``get_wave()`` method to get
the actual data points for a step.

Use the method ``get_axis()`` to get the 'time' data. If there were multiple steps in the simulation, specify
Expand All @@ -38,8 +38,11 @@ Note that all the data will be returned as numpy arrays.

See the class documentation for more details :

- :py:class:`spicelib.raw_read.RawRead`
- :py:class:`spicelib.raw_classes.Trace`
- :py:class:`spicelib.RawRead`
- :py:class:`spicelib.raw.raw_classes.Axis`
- :py:class:`spicelib.Trace`
- :py:class:`spicelib.raw.raw_classes.TraceRead`


Example
-------
Expand Down
4 changes: 2 additions & 2 deletions doc/modules/write_rawfiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ containing a 10kHz sine and a 9.997kHz cosine wave.
For more information, see :

- :doc:`../varia/raw_file`
- :py:class:`spicelib.raw_write.RawWrite`
- :py:class:`spicelib.raw_write.Trace`
- :py:class:`spicelib.RawWrite`
- :py:class:`spicelib.Trace`

0 comments on commit c3a424e

Please sign in to comment.