PurlDB: purl2sym Packaging and documentation

[DennisClark]

This documentation is part of the standard PurlDB doc.
There is also some documentation that needs to live elsewhere:

• Create documentation for source-inspector https://github.com/nexB/source-inspector?tab=readme-ov-file#to-get-started
• Create documentation for symbols and strings pipelines in SCIO Add tutorial for symbol and string collection scancode.io#1198
• Create documentation for symbols and strings collection in PurlDB Add tutorial for symbol and string collection using /api/collect endpoint #411

[keshav-space]

Here is the status for the documentation

• See https://github.com/nexB/source-inspector/blob/main/README.rst for source-inspector documentation.

• Documentation for the collect_symbols and collect_source_strings pipelines in SCIO are available here: https://scancodeio.readthedocs.io/en/latest/built-in-pipelines.html.

  • https://scancodeio.readthedocs.io/en/latest/built-in-pipelines.html#collect-source-strings-addon
  • https://scancodeio.readthedocs.io/en/latest/built-in-pipelines.html#collect-codebase-symbols-addon

• For local installation, also refer to this: https://scancodeio.readthedocs.io/en/latest/installation.html#local-development-installation.

[keshav-space]

More documentation added in

• Add tutorial for symbol and string collection scancode.io#1198
• Add tutorial for symbol and string collection using /api/collect endpoint #411
• Update README with Pygments and Tree-Sitter example source-inspector#22

[keshav-space]

Docs available at:

• https://aboutcode.readthedocs.io/projects/PURLdb/en/latest/how-to-guides/tutorial_symbol_and_string_collection.html
• https://aboutcode.readthedocs.io/projects/PURLdb/en/latest/purldb/symbol_and_string_collection.html
• https://scancodeio.readthedocs.io/en/latest/tutorial_web_ui_symbol_and_string_collection.html
• https://github.com/nexB/source-inspector/blob/main/README.rst