Contribute to the manual

Development environment

• Linux
• Windows
• Mac
• Tools

Contribute

Note

Click here to learn about the forking workflow on Github.

• Fork the repository: https://github.com/Quantum-Creative-Group/quantum_nodes

• Do your modifications

• Once you are ready, open a new pull request

• Wait for your modifications to be reviewed and accepted

Guidelines

1. Files architecture

2. Add a new chapter

Files architecture

docs/
├── _static/
│   ├── animation_nodes_init_replacement_file.txt
│   ├── css/
│   └── images/
│
├── _templates/
│   ├── modules.rst_t
│   ├── packages.rst_t
│   └── toc.rst_t
│
├── build/
│
├── source/
│   ├── conf.py
│   ├── index.rst
│   ├── MethodNameFilter.py
│   ├── spelling_wordlist.txt
│   │
│   ├── [chapter]/
│   │   ├── index.rst
│   │   ├── file.rst
│   │   ├── [subchapter]/
│   │   ├── ...
│   │   └── [subchapter]/
│   │
│   ├── ...
│   └── [chapter]/
│       └── ...
│
└── ...

Add a new chapter

1. Create a new folder

   • If your chapter is a new section, create a new folder under source/

   • If your chapter is a subchapter, create a new folder under source/parent_chapter/

   • Your chapter may be a subsubchapter. No problem, keep the same logic as described before

   • Give it a short and precise name (snake_case naming style)

2. Create a new index.rst file in your chapter

   • This file is the "welcome page" of your chapter

   • Here you can add links to any subchapters and so on ...

3. If you need to add custom css to your pages

   • Create a new folder under docs/_static/css/

   • Give it the same name as your chapter

   • Insert your css files

   • Once this is done, add your path to the html_css_files variable in config.py

In a more visual way, here is the architecture of a section/chapter:

├── index.rst
├── my_subchapter/
│   ├── index.rst
│   ├── my_subsubchapter/
│   ├── file.rst
│   └── ...
├── file.rst
└── ...

So, at the end, here is what the global architecture should look like

docs/
├── _static/
│   ├── animation_nodes_init_replacement_file.txt
│   ├── css/
│   └── images/
│
├── _templates/
│   ├── modules.rst_t
│   ├── packages.rst_t
│   └── toc.rst_t
│
├── build/
│
├── source/
│   ├── conf.py
│   ├── index.rst
│   ├── MethodNameFilter.py
│   ├── spelling_wordlist.txt
│   │
│   ├── my_chapter/
│   │   ├── index.rst
│   │   ├── my_subchapter/
│   │   │   ├── index.rst
│   │   │   ├── my_subsubchapter/
│   │   │   ├── file.rst
│   │   │   └── ...
│   │   ├── file.rst
│   │   └── ...
│   │
│   └── ...
│
└── ...

Git workflow