materiallistgenerator v1.2.2
MateriallistGenerator
Installation
Create an initial package.json file by doing the following:
npm init
Add the following parts to your scripts in package.json
"scripts": {
"init": "node ./node_modules/materiallistgenerator/generatenewproject.js",
"offline": "node --max_old_space_size=8192 ./node_modules/materiallistgenerator/index.js && make html",
"compile": "node --max_old_space_size=8192 ./node_modules/materiallistgenerator/index.js",
"html": "make html"
},
Get the tool via npm:
npm install -s materiallistgenerator
Create an initial project configuration:
npm run-script init
Install other external dependencies
- Python 3.7.3 Download from https://www.python.org/downloads/
- Sphinx 2.0.1 https://pypi.org/project/Sphinx/
pip install Sphinx
- Sphinx RTD Theme 0.4.3 https://pypi.org/project/sphinx-rtd-theme/
pip install sphinx-rtd-theme
- Sphinx recommonmark https://github.com/rtfd/recommonmark
pip install recommonmark
Basis SPHINX SETUP
According to http://www.sphinx-doc.org/en/master/usage/quickstart.html
- Create your folder for the documentation (default: ./export )
- Go to subfolder ( default ./export)
- Run sphinx-quickstart
sphinx-quickstart
- Use the Materiallistgenerator and use the sphinx source directory as target
- Take care, that you activated all the necessary settings in conf.py (e.g. templates, extentions, name-settings,...)
Use the Materiallist Generator
Basic Usage
Configuration File Settings
update the configuration.json file in your folder with a reference to the SAP XLSX File
Main Settings:
- Project: Name of your project
- Version: Version Identifier
- Author: Author named
- Copyright: in case of copyright remarks
File - Settings:
- file: Main Data file as XLSX-File
- custom: Additions File
Folder - Settings:
- Main folder to place data
Template - Settings:
- Template to use to generate Sphinx Sites
{
"project": "test",
"version": "0.0.1",
"author": "Thomas Schneider",
"copyright": "-",
"file": "YOUR_PATH_TO_XLSX_FILE",
"custom": "YOUR_PATH_TO_MODIFICATION_XLSX_FILE",
"target": "./source/gen",
"source": "./source/assets/DOCS",
"thumbs": "./source/assets/DOCS_thumb",
"template": "./templates/template.rst",
"imagemap": "./templates/template_imagemap.html"
}
Just compile your SAP XLSX Data to Markdown
update the configuration.json file in your folder with a reference to the SAP XLSX File
Run the following
npm run-script compile
Generate SPHINX E-Dok from Markdown Files
run the sphinx-build - Tool, either directly using sphinx-build or typing
npm run-script html
Browse to build/html/index.html to find the resulting offline website
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago