search

tpoikela / uvm-python

UVM 1.2 port to Python
Apache License 2.0
243 stars 46 forks source link

Documentation rendering issue #27

Closed sjalloq closed 3 years ago

sjalloq commented 3 years ago

I've been browsing the documentation and there are a whole heap of instances where the code formatting has been lost. For example, the code snippet here is rendered as plain text making it difficult to read.

https://uvm-python.readthedocs.io/en/latest/uvm_users_guide_1.2.html#register-types

sjalloq commented 3 years ago

Hmmm, I've just seen that most of those code examples are SV anyway. Perhaps it's all just broken?

cmarqu commented 3 years ago

AFAIK, this documentation once was the original documentation for UVM-SV which has been converted to RestructuredText and slightly been adapted for uvm-python, but not fully. Since most (all)? of the class and method names have been kept, it's still useful, you just need to mentally convert the syntax to Python and look in the examples and tests of this repo for "interesting" names.

sjalloq commented 3 years ago

Thanks. I noticed not long after I posted that the examples I was looking at were all SV and not Python. I've since found the test/examples/simple directory which helps.

One question though - can I use the UVMReg and associated classes on their own outside of a UVM testbench? We're using standard Cocotb with the cocotb-coverage extension but I want to use this register model. I noticed in the examples there are calls to uvm_object_utils(). Does this register some functionality that then means you have to use UVM higher level classes or will it work using uvm_reg_block as the top level?

cmarqu commented 3 years ago

This would be a question for @tpoikela I'm afraid. If you get this to work, it would be good to know though.

sjalloq commented 3 years ago

Moving question to new issue.

sjalloq commented 3 years ago

Closing this issue as the documentation question has been answered.

tpoikela commented 3 years ago

Hi

The docs are not fully finished yet. I did the initial conversion and transferred all the images, but as you can see, some examples are still in SV. Also, automatic conversion messed up some code formatting and tables, and I have been manually fixing these. As the documentation is quite long, it is a huge job. I hope to be able to continue making improvements in the future, but lately code and functionality have taken the priority.

On Wed, Jan 27, 2021, 10:48 Shareef Jalloq notifications@github.com wrote:

Closing this issue as the documentation question has been answered.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/tpoikela/uvm-python/issues/27#issuecomment-768132114, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACG7SW237XQ3AMT6YGNFHYLS37HN3ANCNFSM4WTZ2JYQ .