Add Python documentation generation #1218
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Error: ERROR:root:Class pyslang.BreakStatement.EvalResult previously found in pyslang.BlockStatement.EvalResult, only one occurrence will be chosen. Ensure each class is exposed only in a single module for generating correct documentation.
|
Yeah, I think it should be merged into the CMakeLists so that it can reuse the mcss checkout we already have, and also make sure the outputs end up in the right place. You should be able to navigate to the output website locally and see that it's all working correctly. Also we'll need an actual link to the Python docs from the main website page somewhere. CMake can run arbitrary commands; the syntax is ugly but otherwise it's not too bad. |
| @@ -27,7 +27,7 @@ void registerStatements(py::module_& m) { | |||
| return fmt::format("Statement(StatementKind.{})", toString(self.kind)); | |||
| }); | |||
|
|
|||
| py::enum_<Statement::EvalResult>(stmt, "EvalResult") | |||
| py::enum_<Statement::EvalResult>(m, "EvalResult") | |||
| @@ -37,7 +37,8 @@ set(DOXYGEN_TAGFILES | |||
| set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in) | |||
| set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) | |||
| set(SCRIPTS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/../scripts) | |||
| set(DOXYGENPY_PATH "${mcss_SOURCE_DIR}/documentation/doxygen.py") | |||
| set(MCSS_DOXYGENPY_PATH "${mcss_SOURCE_DIR}/documentation/doxygen.py") | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Here's my first go at Python documentation generation.
Things to check with it:
docs/CMakeLists.txtfile? Should it go in a different CMake file? Should it be done exclusively in a GH Action (as it is now)? I don't know which direction you want to take with it, and am too novice at CMake to decide/implement.