)]}'
{"CONTRIBUTING.rst":[{"author":{"_account_id":10239,"name":"Dmitry Tantsur","email":"dtantsur@protonmail.com","username":"dtantsur"},"change_message_id":"30db7a7310fc08df487548ad0c3e6bbe3efc2b91","unresolved":false,"context_lines":[{"line_number":264,"context_line":"    ``**`` argument is needed so that we can add optional arguments without"},{"line_number":265,"context_line":"    breaking out-of-tree plugins. Please make sure to include and ignore it."},{"line_number":266,"context_line":""},{"line_number":267,"context_line":".. _ironic_inspector.plugins.base: https://docs.openstack.org/ironic-inspector/latest/_modules/ironic_inspector/plugins/base.html"},{"line_number":268,"context_line":".. _Introspection Rules: https://docs.openstack.org/ironic-inspector/latest/user/usage.html#introspection-rules"},{"line_number":269,"context_line":""},{"line_number":270,"context_line":"Making changes to the database"}],"source_content_type":"text/x-rst","patch_set":1,"id":"b2fcd204_b740b983","line":267,"updated":"2021-07-01 13:10:36.000000000","message":"This is not quite the same as the previous link. It is the source code, while we need to link to the generated documentation.\n\nApparently, the way these files are generated has changed, there used to be a file per module, now there is a file per package (check the generated doc/source/contributor/api to see what I mean). I think to fix it you only need to add `apidoc_separate_modules \u003d True` to doc/source/conf.py (see https://github.com/sphinx-contrib/apidoc/blob/master/README.rst_\n\nFurthermore, this is an internal link. I suggest we use this patch as a chance to stop using global links for internal locations. One of the way to link to another document is :doc:`/path/to/document` right in the text. So in this case \".... defined in :doc:`/contributor/api/ironic.inspector.base` and overwrite ...\" (I\u0027m omitting the \"module\" word because the link title already has it - see for yourself). This separate URL definition can then be removed.","commit_id":"ab618c01a0f100f21afaeddc395bc54bca7d2bd2"},{"author":{"_account_id":33344,"name":"cenne","email":"cennedee+opendev@protonmail.com","username":"cenne.d","status":"effervescent bubbling"},"change_message_id":"3125cf1d81af0b86c4847bb1c16a6e657892fb12","unresolved":true,"context_lines":[{"line_number":264,"context_line":"    ``**`` argument is needed so that we can add optional arguments without"},{"line_number":265,"context_line":"    breaking out-of-tree plugins. Please make sure to include and ignore it."},{"line_number":266,"context_line":""},{"line_number":267,"context_line":".. _ironic_inspector.plugins.base: https://docs.openstack.org/ironic-inspector/latest/_modules/ironic_inspector/plugins/base.html"},{"line_number":268,"context_line":".. _Introspection Rules: https://docs.openstack.org/ironic-inspector/latest/user/usage.html#introspection-rules"},{"line_number":269,"context_line":""},{"line_number":270,"context_line":"Making changes to the database"}],"source_content_type":"text/x-rst","patch_set":1,"id":"de64f67f_52a56ff3","line":267,"in_reply_to":"b2fcd204_b740b983","updated":"2021-07-01 15:10:29.000000000","message":"Yes, I did also find the module docs for example under https://docs.openstack.org/ironic-inspector/latest/contributor/api/ironic_inspector.plugins.html#ironic_inspector.plugins.base\n\nBut then thought the actual module code link seemed more suitable for the following reasons.\n\n* It\u0027s seemed so much more readable and with better color and syntax highlighting etc, compared to the docs in which I seemed to easily get lost. \n\n* Also because in these both cases the code files were smaller, compared to the whole package documentation pages.\n\n* The `Making changes to the database` section seems to be suggesting to modify code so felt apt to link directly to the code. \n\n\nI\u0027ll start trying to replace global links to internal. and activate the seperate modules option. After that should I keep the the source code links or the processed docs?","commit_id":"ab618c01a0f100f21afaeddc395bc54bca7d2bd2"},{"author":{"_account_id":10239,"name":"Dmitry Tantsur","email":"dtantsur@protonmail.com","username":"dtantsur"},"change_message_id":"e9b32ec9a7b1cb05bb76a86c66010f6ffb0d8318","unresolved":true,"context_lines":[{"line_number":264,"context_line":"    ``**`` argument is needed so that we can add optional arguments without"},{"line_number":265,"context_line":"    breaking out-of-tree plugins. Please make sure to include and ignore it."},{"line_number":266,"context_line":""},{"line_number":267,"context_line":".. _ironic_inspector.plugins.base: https://docs.openstack.org/ironic-inspector/latest/_modules/ironic_inspector/plugins/base.html"},{"line_number":268,"context_line":".. _Introspection Rules: https://docs.openstack.org/ironic-inspector/latest/user/usage.html#introspection-rules"},{"line_number":269,"context_line":""},{"line_number":270,"context_line":"Making changes to the database"}],"source_content_type":"text/x-rst","patch_set":1,"id":"ae0eb420_4faed1e3","line":267,"in_reply_to":"de64f67f_52a56ff3","updated":"2021-07-01 15:54:34.000000000","message":"The good things about the docs is that they\u0027re covering the interface only, without going into details or cluttering the view with imports and private functions.\n\n\u003e Also because in these both cases the code files were smaller, compared to the whole package documentation pages.\n\nThe conf.py option I mentioned will turn package documentation pages into module ones again.\n\n\u003e The `Making changes to the database` section seems to be suggesting to modify code so felt apt to link directly to the code.\n\nHmm. In this case it does make some sense.","commit_id":"ab618c01a0f100f21afaeddc395bc54bca7d2bd2"},{"author":{"_account_id":10239,"name":"Dmitry Tantsur","email":"dtantsur@protonmail.com","username":"dtantsur"},"change_message_id":"30db7a7310fc08df487548ad0c3e6bbe3efc2b91","unresolved":false,"context_lines":[{"line_number":311,"context_line":"    ironic-inspector-dbsync revision -m \"A short description\""},{"line_number":312,"context_line":""},{"line_number":313,"context_line":".. _Create a Migration Script: http://alembic.zzzcomputing.com/en/latest/tutorial.html#create-a-migration-script"},{"line_number":314,"context_line":".. _ironic_inspector.db: https://docs.openstack.org/ironic-inspector/latest/_modules/ironic_inspector/db.html"},{"line_number":315,"context_line":".. _What does Autogenerate Detect (and what does it not detect?): http://alembic.zzzcomputing.com/en/latest/autogenerate.html#what-does-autogenerate-detect-and-what-does-it-not-detect"},{"line_number":316,"context_line":""},{"line_number":317,"context_line":"Implementing PXE Filter Drivers"}],"source_content_type":"text/x-rst","patch_set":1,"id":"0efdbf83_0c97352d","line":314,"updated":"2021-07-01 13:10:36.000000000","message":"Same here","commit_id":"ab618c01a0f100f21afaeddc395bc54bca7d2bd2"}]}