Skip to content

Clean up documentation files#25

Merged
DanielaOrtner merged 13 commits into
RebelToolbox:mainfrom
madmiraal:cleanup-docs
Jan 4, 2024
Merged

Clean up documentation files#25
DanielaOrtner merged 13 commits into
RebelToolbox:mainfrom
madmiraal:cleanup-docs

Conversation

@madmiraal
Copy link
Copy Markdown
Contributor

Address multiple issues in the API XML documentation, the API RST documentation generation, and the API and editor translations including:

  • Fixing the unwanted line-break and space in the documentation of an empty Dictionary default value.
  • Fixing the API XML documentation generation tool not removing indents on multi-line entries.
  • Fixing the XML to RST documentation creation tool not removing indents properly.
  • Updating the Python shebang of the documentation status tool.
  • As done in Apply Rebel coding style #19 (9c8daa9), replacing tabs with spaces in all documentation files.
  • As done in Use SPDX standard headers for all code files #22, adding SPDX standard headers to all documentation and translation files.
  • Using docs instead of doc when referencing multiple documentation files; including the documentation folders.
  • Renaming the --doctool option to --generate-docs.
  • Removing various unused documentation creation tools.

@DanielaOrtner DanielaOrtner self-requested a review January 3, 2024 16:47
Copy link
Copy Markdown
Contributor

@DanielaOrtner DanielaOrtner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic PR! The changes make the code so much clearer :)

@DanielaOrtner DanielaOrtner merged commit e3e018e into RebelToolbox:main Jan 4, 2024
@madmiraal madmiraal deleted the cleanup-docs branch January 4, 2024 07:28
@madmiraal madmiraal added PR Type: Bug Fix Your current game should now work as expected. PR Type: Enhancement Your current game will work better. and removed bug labels May 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR Type: Bug Fix Your current game should now work as expected. PR Type: Enhancement Your current game will work better.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants