colrev.package_manager.doc_registry_manager.PackageDoc¶
- class PackageDoc(package_id)[source]¶
Bases:
objectMethods
Get the documentation item for the package
Get the endpoint item for the package
Check if the package has a specific endpoint type
Import the package documentation
Attributes
repositorypackage_idversionlicenseauthorsdocumentationpackage_dirmonorepopackage_metadatadescriptiondev_statusendpointssearch_typesdocs_package_readme_pathdocs_rst_path- get_docs_item()[source]¶
Get the documentation item for the package
- Return type:
dict
Format: {
“identifier”: package_id, “short_description”: short_description, “path”: docs_rst_path,
}
- get_endpoint_item(endpoint_type)[source]¶
Get the endpoint item for the package
- Return type:
dict
Format: {
“package_endpoint_identifier”: package_id, “status”: status, “short_description”: docs_short_description, “search_types”: search_types,
}