Convert generate_options.pl to python. #534
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I noticed that
Options.rstwas outdated, it was missing several items that were defined in source codeFor many options,
Options.rstis the only page on the internet that mentions them. This causes that page to receive a lot of search traffic, despite it being a very poor source of information (as mentioned in the intro). Because of this, I'm planning to update this to be a better source of documentation. This will involve quite some code, as I'm not a Perl-expert, I decided to convertgenerate_options.plto python. As this project builds on sphynx, python is already a dependency, making it a better match than Perl. These days, python developers are more common than Perl developers, so this broadens the audience a bit, too.Regenerated
Options.rstagainst uwsgi 2.0.28, which is the latest version on pypi at the time of writing.This PR is 'testing the waters' to see if the project is interested in the contributions i'm planning. Feel free to redirect my efforts elsewhere. My plans for the future include:
socketanduwsgi-socket). This will substantially reduce the number of options.funcarguments, to provide a more human-readable experienceI also plan on improving other documentation content unrelated to
Options.rst, but as this is the main file in most google searches, I feel my effort should primarily be spent there.