Add Python documentation generation #1218
Conversation
|
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") | |||
There was a problem hiding this comment.
It gave an error/caused an issue during documentation generation. I also believed that this new way is the way it should have been; maybe an example/test case would be good to reinforce what's intended with it if you disagree though!
parker-research
force-pushed
the
python-docs
branch
from
a8a4a7e to
3c7772a
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1218 +/- ##
=======================================
Coverage 94.74% 94.74%
=======================================
Files 205 205
Lines 51218 51218
=======================================
Hits 48524 48524
Misses 2694 2694 Continue to review full report in Codecov by Sentry.
|
|
Just pushed my latest here. I'm getting some sort of error, but it seems like it might be related to the existing Doxygen generation? Would appreciate it if you could take a quick look if you get a chance. Note that the CMakeLists currently pull from my fork of your fork of m.css. If you can merge this PR, we can switch it back to your releases - MikePopoloski/m.css#1 |
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.
parker-research
force-pushed
the
python-docs
branch
from
60238de to
18cff7b
Compare
|
Ready for your review again! I think maybe the only last remaining part is a link from the Doxygen docs to these docs. |
|
I got the paths fixed up and the docs are live now; you can see them at https://sv-lang.com/pyslang/ We can add a link from the main page once there's some content on that landing page. |
|
Awesome, thanks for working through that final debugging! |
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.