Skip to content

Easily parse a CODESYS project into a Sphinx Source structure. To easily create and maintain your CODESYS documentation.

License

Notifications You must be signed in to change notification settings

Bakker-Martijn/CODESYS-doc-export

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Parse CODESYS project into a Spinx Source structure.

This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.
Creative Commons License

What does the script do?

The script can be ran from the CODESYS ide. And will parse all Pou's, structs etc. in to a folder structure. To see how generated documentation (can) look: Sample documentation

How does it work?

1. CodeSys project:

Create a CODESYS project, describe the variables etc. correctly(!)
See the Sample documentation page for tips on how to create documentation

CODESYS Project

2. Exported Files:

Run the CODESYS_Export.py script.
The folders will be saved in a directory of choice.

Exported files

Documentation:

Generate documentation using Sphinx

Exported files

Setting up:

See the Setting up page for info on how to setup and host your documentation on: ReadTheDocs.

About

Easily parse a CODESYS project into a Sphinx Source structure. To easily create and maintain your CODESYS documentation.

Topics

Resources

License

Stars

Watchers

Forks

Languages