-
Notifications
You must be signed in to change notification settings - Fork 41
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Move the static text in helpdata.txt to Sphinx #1264
Comments
The idea is be to eventually generate |
Associated with #506 |
@lmoureaux @daavko any ideas on how to integrate the static text in helpdata.txt into RTD? Do we want to wire it into existing folders or do a separate "help" folder? The title "strategy and tactics" is already how-to-play.rst, so could create more pages in Playing. |
I'd guess reproduce the in-game help structure in the rtd? |
|
What should be documented? Is there something wrong in the documentation?
Right now we have a generalized, non-ruleset specific "how to play" type content in the
helpdata.txt
file. Intertwined in this static text is generated ruleset specific help for units, improvements, wonders, etc. This should be moved to Sphinx.Do you have suggestions?
Update/replace the current "How to Play" RTD page with the static content from
helpdata.txt
. This will enable us to use the QtHelp builder of Sphinx to ship some or all of thedocs
with the package. This would allow cross links between documents.The text was updated successfully, but these errors were encountered: