Skip to content

Commit

Permalink
added doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Su Tian authored and Su Tian committed Aug 18, 2020
1 parent 1132f84 commit 7bf3404
Show file tree
Hide file tree
Showing 108 changed files with 30,151 additions and 40 deletions.
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"restructuredtext.confPath": "${workspaceFolder}\\doc\\source"
}
Binary file modified __pycache__/analysis.cpython-37.pyc
Binary file not shown.
Binary file modified __pycache__/presg.cpython-37.pyc
Binary file not shown.
Binary file modified __pycache__/utils.cpython-37.pyc
Binary file not shown.
19 changes: 19 additions & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Binary file added doc/build/doctrees/environment.pickle
Binary file not shown.
Binary file added doc/build/doctrees/index.doctree
Binary file not shown.
Binary file added doc/build/doctrees/ioutils.doctree
Binary file not shown.
Binary file added doc/build/doctrees/iovabs.doctree
Binary file not shown.
Binary file added doc/build/doctrees/msmio.doctree
Binary file not shown.
Binary file added doc/build/doctrees/msmstructure.doctree
Binary file not shown.
Binary file added doc/build/doctrees/others.doctree
Binary file not shown.
Binary file added doc/build/doctrees/sg.doctree
Binary file not shown.
Binary file added doc/build/doctrees/utilities.doctree
Binary file not shown.
4 changes: 4 additions & 0 deletions doc/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: aa61ac1919a7268937c99ae3e4e464e0
tags: 645f666f9bcd5a90fca523b33c5a78b7
22 changes: 22 additions & 0 deletions doc/build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. Some scripts documentation master file, created by
sphinx-quickstart on Tue Sep 3 13:43:15 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Some scripts's documentation!
========================================

.. toctree::
:maxdepth: 2
:caption: Contents:

sg
iovabs
ioutils

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
18 changes: 18 additions & 0 deletions doc/build/html/_sources/ioutils.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
I/O Utility Functions
=====================

.. highlight:: python

::

import msgpi.io.utils

.. autofunction:: msgpi.io.utils.writeFormatIntegers

.. autofunction:: msgpi.io.utils.writeFormatFloats

.. autofunction:: msgpi.io.utils.writeFormatIntegersMatrix

.. autofunction:: msgpi.io.utils.writeFormatFloatsMatrix

.. autofunction:: msgpi.io.utils.textToMatrix
33 changes: 33 additions & 0 deletions doc/build/html/_sources/iovabs.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
SG I/O Module for VABS
======================

.. highlight:: python

::

import msgpi.io.iovabs

Reading Functions
-----------------

.. autofunction:: msgpi.io.iovabs.readVABSIn

.. autofunction:: msgpi.io.iovabs.readVABSOutHomo

Writing Functions
-----------------

.. autofunction:: msgpi.io.iovabs.writeVABSIn

.. autofunction:: msgpi.io.iovabs.writeVABSNodes

.. autofunction:: msgpi.io.iovabs.writeVABSElements

.. autofunction:: msgpi.io.iovabs.writeVABSElementOrientations

.. autofunction:: msgpi.io.iovabs.writeVABSMOCombos

.. autofunction:: msgpi.io.iovabs.writeVABSMaterials

.. autofunction:: msgpi.io.iovabs.writeVABSMacroData

9 changes: 9 additions & 0 deletions doc/build/html/_sources/msmio.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
I/O Module for MSM Codes
========================

.. highlight:: python

::

import msmio

12 changes: 12 additions & 0 deletions doc/build/html/_sources/msmstructure.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Class Module for MSM Beam Structure
===================================

.. highlight:: python

::

import msg.beam

.. autoclass:: msg.beam.Beam
:members:

10 changes: 10 additions & 0 deletions doc/build/html/_sources/others.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Others
======

.. highlight:: python

::

import tempscripts

.. autofunction:: tempscripts.calcCTMKeyPoints
21 changes: 21 additions & 0 deletions doc/build/html/_sources/sg.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Class Module for MSM Structure Gene
===================================

.. highlight:: python

::

import msgpi.sg

Material Section
----------------

.. autoclass:: msgpi.sg.MaterialSection
:members:

Structure Gene
--------------

.. autoclass:: msgpi.sg.StructureGene
:members:

20 changes: 20 additions & 0 deletions doc/build/html/_sources/utilities.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Utility Functions
=================

.. highlight:: python

::

import msg.utilities

.. autofunction:: msg.utilities.calcGeneralRotation3D

.. autofunction:: msg.utilities.calcCab

.. autofunction:: msg.utilities.textToMatrix

.. autofunction:: msg.utilities.writeFormatIntegers

.. autofunction:: msg.utilities.writeFormatFloats

.. autofunction:: msg.utilities.updateXMLElement
Binary file added doc/build/html/_static/ajax-loader.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 7bf3404

Please sign in to comment.