Skip to content

Commit f918c21

Browse files
author
David Erb
committed
Merge branch 'remove-contexts' into main
2 parents 364c121 + 3c6d920 commit f918c21

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+854
-799
lines changed

docs/explanations/conventions.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
..
2+
Use the file automatically generated by dae-devops.
3+
4+
.. include:: ../../.dae-devops/docs/conventions.rst
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
..
2+
Use the file automatically generated by dae-devops.
3+
4+
.. include:: ../../.dae-devops/docs/docs_structure.rst

docs/explanations/index.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
:orphan:
2+
3+
Explanations
4+
============
5+
6+
Explanation, or discussions, clarify and illuminate a particular topic. They broaden the documentation's coverage of a topic.
7+
8+
.. toctree::
9+
10+
docs_structure
11+
conventions
12+
todo

docs/explanations/todo.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
TODO
2+
=======================================================================
3+
4+
- Remove matplotlib from imports done by mib2hdfConvert package to decrease load time and debug volume.
5+
- Make sure we can collect and process mib files which are not in a material subdirectory.
6+
- Add unit tests for the mib_convert task.
7+

docs/how-to/developing.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
..
2+
Use the file automatically generated by dae-devops.
3+
4+
.. include:: ../../.dae-devops/docs/developing.rst

docs/how-to/devops.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
..
2+
Use the file automatically generated by dae-devops.
3+
4+
.. include:: ../../.dae-devops/docs/devops.rst

docs/how-to/documenting.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
..
2+
Use the file automatically generated by dae-devops.
3+
4+
.. include:: ../../.dae-devops/docs/documenting.rst

docs/how-to/index.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:orphan:
2+
3+
How-to Guides
4+
=============
5+
6+
How-to guides take the reader through the steps required to solve a real-world problem.
7+
Practical step-by-step guides for the more experienced user.
8+
9+
.. toctree::
10+
11+
installing
12+
developing
13+
testing
14+
documenting
15+
devops
16+

docs/how-to/installing.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
..
2+
Use the file automatically generated by dae-devops.
3+
4+
.. include:: ../../.dae-devops/docs/installing.rst
5+
6+
Since this package is just a library, the command line doesn't do anything else besides print the version.

docs/how-to/testing.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
..
2+
Use the file automatically generated by dae-devops.
3+
4+
.. include:: ../../.dae-devops/docs/testing.rst

0 commit comments

Comments
 (0)