Operator Docs (#26)

* initial attempt at incorporating dpf html

* add light coloring for menu when webpage width drops past half page

* doc reorg

* added to user_guide

Author: akaszynski

README.md

@@ -1,5 +1,9 @@
 # DPF - Ansys Data Processing Framework
 
+[![PyPI version](https://badge.fury.io/py/ansys-dpf-core.svg)](https://badge.fury.io/py/ansys-dpf-core)
+
+[![Build Status](https://dev.azure.com/pyansys/pyansys/_apis/build/status/pyansys.DPF-Core?branchName=docs%2Foperators)](https://dev.azure.com/pyansys/pyansys/_build/latest?definitionId=2&branchName=docs%2Foperators)
+
 The Data Processing Framework (DPF) is designed to provide numerical
 simulation users/engineers with a toolbox for accessing and
 transforming simulation data. DPF can access data from solver result

ansys/dpf/core/__init__.py

@@ -1,4 +1,3 @@
-import inspect
 import os
 import socket
 

ansys/dpf/core/available_result.py

@@ -16,7 +16,6 @@ def __init__(self, availableresult):
         self._message = availableresult
 
     def __str__(self):
-        
         txt = self.name+'\n' +\
               'Operator name: "%s"\n' % self.operator_name +\
               'Number of components: %d\n' % self.n_components +\

ansys/dpf/core/inputs.py

@@ -78,7 +78,7 @@ def _update_doc_str(self, docstr, class_name):
         self.__class__ = child_class
 
     def __str__(self):
-        docstr = '\033[1m' + self._spec.name + '\033[0m : '
+        docstr = self._spec.name + ' : '
         type_info = self._python_expected_types.copy()
         if self._spec.optional:
             type_info += ['optional']

ansys/dpf/core/outputs.py

@@ -14,22 +14,22 @@ def get_data(self):
         """Returns this output of this operator"""
         type_output = self._spec.type_names[0]
         if type_output == 'abstract_meshed_region':
-            type_output= 'meshed_region'
-            
+            type_output = 'meshed_region'
+
         elif type_output == "fields_container":
-            type_output = ['collection','field']
+            type_output = ['collection', 'field']
 
         return self._operator.get_output(self._pin, type_output)
 
     def __call__(self):
         return self.get_data()
 
-    def __str__(self): 
-        docstr = '\033[1m' + self._spec.name+'\033[0m'
+    def __str__(self):
+        docstr = self._spec.name
         if self._spec.optional:
             docstr += " (optional)"
         docstr += ", expects types:"+'\n'
-        for types in  self._python_expected_types:
+        for types in self._python_expected_types:
             docstr += "   -" + types + '\n'
         if self._spec.document:
             docstr += "help: " + self._spec.document + '\n'

docs/source/_static/css/ansys.css

@@ -14,6 +14,9 @@ h1, h2, h3, h4, h5, h6 {
     font-family: 'Source Sans Pro', sans-serif;
 }
 
+.navbar-toggler-icon {
+    background-image: url("data:image/svg+xml;charset=utf8,%3Csvg viewBox='0 0 32 32' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath stroke='rgba(255,255,255, 0.9)' stroke-width='2' stroke-linecap='round' stroke-miterlimit='10' d='M4 8h24M4 16h24M4 24h24'/%3E%3C/svg%3E") !important;
+}
 
 .sig-prename {
     color: var(--ansysBronze);