Skip to content

Commit

Permalink
[DOCs][Added] More information about rotation and offsets
Browse files Browse the repository at this point in the history
  • Loading branch information
set-soft committed Nov 22, 2023
1 parent cbc196f commit aedabbe
Show file tree
Hide file tree
Showing 4 changed files with 283 additions and 82 deletions.
8 changes: 7 additions & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,20 @@ source/configuration/sup_variants.rst: ../kibot/var_*.py ../kibot/config_reader.
source/configuration/sup_globals.rst: ../kibot/globals.py ../kibot/config_reader.py
../src/kibot --rst --help-global-options > $@

source/rotations.rst: ../kibot/misc.py ../kibot/config_reader.py
../src/kibot --help-list-rotations > $@

source/offsets.rst: ../kibot/misc.py ../kibot/config_reader.py
../src/kibot --help-list-offsets > $@

help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
$(SPHINXTARGETS): Makefile source/configuration/sup_outputs.rst source/dependencies.rst source/usage.txt source/configuration/sup_preflights.rst \
source/configuration/sup_filters.rst source/configuration/sup_variants.rst source/configuration/sup_globals.rst source/errors.rst
source/configuration/sup_filters.rst source/configuration/sup_variants.rst source/configuration/sup_globals.rst source/errors.rst \
source/rotations.rst source/offsets.rst
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)


Expand Down
2 changes: 1 addition & 1 deletion docs/source/configuration/sup_filters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Supported filters
- ``comment`` :index:`: <pair: filter - rot_footprint; comment>` [string=''] A comment for documentation purposes.
- ``extend`` :index:`: <pair: filter - rot_footprint; extend>` [boolean=true] Extends the internal list of rotations with the one provided.
Otherwise just use the provided list.
Note that the provided list has more precendence than the internal list.
Note that the provided list has more precedence than the internal list.
- ``invert_bottom`` :index:`: <pair: filter - rot_footprint; invert_bottom>` [boolean=false] Rotation for bottom components is negated, resulting in either: `(- component rot - angle)`
or when combined with `negative_bottom`, `(angle - component rot)`.
- ``mirror_bottom`` :index:`: <pair: filter - rot_footprint; mirror_bottom>` [boolean=false] The original component rotation for components in the bottom is mirrored before applying
Expand Down
Loading

0 comments on commit aedabbe

Please sign in to comment.