godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
62,488 Commits 15 Branches 59 Tags 2.2 GiB
eb9e193477
Commit Graph

30 Commits

Author SHA1 Message Date
Danil Alexeev
12c86c6716
Documentation: Treat deprecated/experimental members as documented 2024-02-16 17:15:33 +03:00
Hugo Locurcio
c16db0935f
Fix doc_status.py trying to get removed version tag from XML 
This also runs `doc_status.py` on CI to catch potential future regressions.
 2023-07-13 16:25:54 +02:00
Andy Maloney
5036dfb0b6 Add Python PEP 484/526 type hints to doc/tools/doc_status.py 
Also removes the first divider string which cleans up the extraneous dashes at the top of the page.
 2022-07-29 13:27:48 -04:00
Hugo Locurcio
1b01cef301
Update doc_status script to support constructors and operators docs 
- Reorder columns from highest number of items contained within
  to lowest number.
- Remove some obsolete code and fix a typo.
 2022-01-07 23:50:10 +01:00
Rémi Verschelde
cd4e46ee65 SCons: Format buildsystem files with psf/black 
Configured for a max line length of 120 characters.

psf/black is very opinionated and purposely doesn't leave much room for
configuration. The output is mostly OK so that should be fine for us,
but some things worth noting:

- Manually wrapped strings will be reflowed, so by using a line length
  of 120 for the sake of preserving readability for our long command
  calls, it also means that some manually wrapped strings are back on
  the same line and should be manually merged again.

- Code generators using string concatenation extensively look awful,
  since black puts each operand on a single line. We need to refactor
  these generators to use more pythonic string formatting, for which
  many options are available (`%`, `format` or f-strings).

- CI checks and a pre-commit hook will be added to ensure that future
  buildsystem changes are well-formatted.
 2020-03-30 09:05:53 +02:00
Hugo Locurcio
7c3f6b2870
Improve the doc_status.py console output 
- Duplicate the header when the `-a` flag is enabled. Since lots of
  items are displayed in this case, this helps the user remember
  which column is which without having to scroll back to the top.
- Bolden the overall percentages for easier visual grepping.
 2020-02-01 00:24:39 +01:00
Tomasz Chabora
25ea912d96 Count theme items in doc_status.py 2020-01-24 14:23:58 +01:00
Hugo Locurcio
17add2dc86
Add a pre-commit hook to check the class reference syntax 
This also makes documentation helper scripts executable.
 2019-12-06 23:40:19 +01:00
SamuelDeboni
35d22e414f Fixed AttributeError on doc_status.py 2019-10-08 11:29:59 -03:00
Rémi Verschelde
6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
Rémi Verschelde
5f8af252e8 doc: Use HTTPS for docs.godotengine.org and point to latest branch 
Fixes #23509.
 2018-11-05 08:46:27 +01:00
Rémi Verschelde
f5c513ca7b doc status: Partial revert of e23454d, setgets are no longer listed 2017-11-24 18:25:56 +01:00
Grosskopf
b4b632a37e filtering getters&setters over strings works for AudioStreamPlayer* 2017-10-15 09:28:29 +02:00
mhilbrunner
b772f5adc9 doc_status.py: Error message for unknown CLI flag, switch shebang to python 2017-10-07 14:57:04 +02:00
mhilbrunner
328b78a0b9 doc_status.py: Add -e (--empty) option to hide items with nothing left to do 2017-10-03 21:58:38 +02:00
Andreas Haas
a4cfec4e21 Merge pull request #11757 from mhilbrunner/doc_status_py27 
doc_status.py Python 2.7 backwards compatibility & Windows support
 2017-10-02 22:24:38 +02:00
Poommetee Ketson
5005818798 Merge pull request #11654 from bojidar-bg/docstatus-fnmatch 
Allow using wildcards to filter docstatus class names
 2017-10-02 23:31:52 +07:00
mhilbrunner
2d46ee36cc doc_status.py Python 2.7 backwards compatibility 2017-10-01 21:47:54 +02:00
Bojidar Marinov
1f60d0c23f
Allow using wildcards to filter docstatus class names 
[ci skip]
 2017-09-28 13:13:32 +03:00
Bojidar Marinov
ca72a4806f
Make doc_status output a bit more markdown-friendly, hide some prints 2017-09-16 13:47:44 +03:00
Daniel J. Ramirez
e23454d5c3 Update doc status generator. 
[ciskip]
 2017-09-15 12:12:22 -05:00
Rémi Verschelde
5d10b8fabd Doc: Drop unmainted converters for html, textile, dokuwiki 2017-05-06 23:43:02 +02:00
Rémi Verschelde
4989cc3617 Fix URLs to moved docs pages 
Closes #8266.
 2017-04-05 07:34:27 +02:00
Bojidar Marinov
669956849a
Update classes.xml to master version, add a small feature to doc_status 2017-03-29 22:27:59 +03:00
Rémi Verschelde
817dd7ccbb style: Fix PEP8 blank lines issues in Python files 
Done with `autopep8 --select=E3,W3`, fixes:

- E301 - Add missing blank line.
- E302 - Add missing 2 blank lines.
- E303 - Remove extra blank lines.
- E304 - Remove blank line following function decorator.
- E309 - Add missing blank line.
- W391 - Remove trailing blank lines.
 2016-11-01 00:35:16 +01:00
Rémi Verschelde
d4c17700aa style: Fix PEP8 whitespace issues in Python files 
Done with `autopep8 --select=E2,W2`, fixes:

- E201 - Remove extraneous whitespace.
- E202 - Remove extraneous whitespace.
- E203 - Remove extraneous whitespace.
- E211 - Remove extraneous whitespace.
- E221 - Fix extraneous whitespace around keywords.
- E222 - Fix extraneous whitespace around keywords.
- E223 - Fix extraneous whitespace around keywords.
- E224 - Remove extraneous whitespace around operator.
- E225 - Fix missing whitespace around operator.
- E226 - Fix missing whitespace around operator.
- E227 - Fix missing whitespace around operator.
- E228 - Fix missing whitespace around operator.
- E231 - Add missing whitespace.
- E231 - Fix various deprecated code (via lib2to3).
- E241 - Fix extraneous whitespace around keywords.
- E242 - Remove extraneous whitespace around operator.
- E251 - Remove whitespace around parameter '=' sign.
- E261 - Fix spacing after comment hash.
- E262 - Fix spacing after comment hash.
- E265 - Format block comments.
- E271 - Fix extraneous whitespace around keywords.
- E272 - Fix extraneous whitespace around keywords.
- E273 - Fix extraneous whitespace around keywords.
- E274 - Fix extraneous whitespace around keywords.
- W291 - Remove trailing whitespace.
- W293 - Remove trailing whitespace.
 2016-11-01 00:35:16 +01:00
Rémi Verschelde
97c8508f5e style: Start applying PEP8 to Python files, indentation issues 
Done with `autopep8 --select=E1`, fixes:

- E101 - Reindent all lines.
- E112 - Fix under-indented comments.
- E113 - Fix over-indented comments.
- E115 - Fix under-indented comments.
- E116 - Fix over-indented comments.
- E121 - Fix a badly indented line.
- E122 - Fix a badly indented line.
- E123 - Fix a badly indented line.
- E124 - Fix a badly indented line.
- E125 - Fix indentation undistinguish from the next logical line.
- E126 - Fix a badly indented line.
- E127 - Fix a badly indented line.
- E128 - Fix a badly indented line.
- E129 - Fix a badly indented line.
 2016-11-01 00:33:51 +01:00
Rémi Verschelde
fc8ccd5b8c SCsub: Add python shebang as a hint for syntax highlighting 
Also switch existing shebangs to "better" /usr/bin/env python.
 2016-10-17 20:10:46 +02:00
Rémi Verschelde
034d6e811f Various improvements to doc_status.py 
- Make comments opt-in (smaller table in width)
- Reduce length of Brief Description and Description (also smaller table as output)
- Make names cyan (blue is too dark on black terminal)
- Drop some redundant synonyms for the flags
 2016-04-26 21:35:06 +02:00
Bojidar Marinov
c9340cdcc6 Add a python script to check the current doc status 2016-04-22 18:32:15 +03:00