Skip to content

Commit

Permalink
Revert to the previous version of makerst which generates documentati…
Browse files Browse the repository at this point in the history
…on more compatible with github wiki
  • Loading branch information
jonri committed Oct 28, 2023
1 parent a05f4ee commit d71eeff
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 15 deletions.
17 changes: 3 additions & 14 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,15 @@ jobs:
- name: Download makerst.py
uses: carlosperate/download-file-action@v1.0.3
with:
file-url: https://raw.githubusercontent.com/godotengine/godot/4.1/doc/tools/make_rst.py

- name: Download version.py
uses: carlosperate/download-file-action@v1.0.3
with:
file-url: https://raw.githubusercontent.com/godotengine/godot/4.1/version.py
file-url: https://raw.githubusercontent.com/godotengine/godot/3.2/doc/tools/makerst.py

- name: Export XML documentation to RST and fix up for Github
run: |
mkdir .wiki
python3 ./make_rst.py --output .wiki/ doc_classes/ || /bin/true
python3 ./makerst.py --output .wiki/ doc_classes/ || /bin/true
for i in .wiki/*
do
sed -i \
-e '1d' \
-e '2i*This file is automatically generated. To make changes, please edit the corresponding xml file in the doc_classes/ folder instead.*' \
-e 's/:ref:`\([^<]*\)<\([^>]*\)>`/`\1 <\2>`_/g' \
-e '/^\.\. /d' \
-e '/:widths:/d' \
$i
sed -i -e '1d' -e '2i*This file is automatically generated. To make changes, please edit the corresponding xml file in the doc_classes/ folder instead.*' -e 's/:ref:`\([^<]*\)<\([^>]*\)>`/`\1 <\2>`_/g' $i
done
echo "Done"
Expand Down
2 changes: 1 addition & 1 deletion doc_classes/HydroRigidBody.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</brief_description>
<description>
When an object enters the water, three forces will be calculated:
[b]Buoyancy[/b] - the pressure of the displaced water causes an object to float.
[b]Buoyancy[/b] - the pressure of the displaced water causes an object to float.
[b]Drag[/b] - an object moving through the water will slow down. The amount of drag is dependent on the object's shape.
[b]Lift[/b] - an object moving through the water at an angle will generate lift, the way a boat lifts out of the water. This is also dependent on the object's shape.

Expand Down

0 comments on commit d71eeff

Please sign in to comment.