Fix docstyle issues

pombredanne · pombredanne · commit 28da568d7d40 · 2026-01-23T18:00:32.000+01:00
Signed-off-by: Philippe Ombredanne &lt;pombredanne@aboutcode.org&gt;
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -1 +1,3 @@
+:orphan:
+
 .. include:: ../../CHANGELOG.rst
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _contributing:
 
 Contributing to PurlDB
diff --git a/docs/source/funding.rst b/docs/source/funding.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Funding
 =======
 
diff --git a/docs/source/getting-started/index.rst b/docs/source/getting-started/index.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Getting Started
 ===============
 
diff --git a/docs/source/how-to-guides/index.rst b/docs/source/how-to-guides/index.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 How-To-Guides
 =============
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -12,9 +12,10 @@ PurlDB offers:
   aka. open code knowledge base.
 - A code matching capability to identify and find similar code to existing indexed FOSS code using
   this knowledge base.
-- Additional utilities to help asses the quality and integrity of software packages as used in the
+- Additional utilities to help assess the quality and integrity of software packages as used in the
   software supply chain.
 
+
 Documentation overview
 ~~~~~~~~~~~~~~~~~~~~~~
 
@@ -25,6 +26,7 @@ to help you know where to look for certain things.
 
 .. rst-class:: column column2 top-left
 
+
 Getting started
 ~~~~~~~~~~~~~~~~~~~~~~
 
@@ -34,6 +36,7 @@ Start here if you are new to PurlDB.
 
 .. rst-class:: column column2 top-right
 
+
 How-To
 ~~~~~~~~~~~~~~~~~~~~~~
 
@@ -83,41 +86,3 @@ Indices and tables
     :maxdepth: 2
     :hidden:
 
-What can you do with PurlDB?
-============================
-
-- Build a comprehensive open source software packages knowledge base. This includes the extensive
-  scan of package code for origin, dependencies, embedded packages and licenses.
-
-- Create advanced analysis for open source packages by collecting
-  :ref:`symbols_and_strings`.
-
-- Detect software supply chain issues by mapping package binaries to their corresponding source code
-  and determining if there are possible discrepancies between sources and binaries (such as with the
-  XZ utils attack, or sources and binaries, where package may not report the exact source code
-  used to build binaries with the :ref:`deploy_to_devel` mapping analysis.
-
-- Access multiple services keyed by PURL, such as metadata, package versions, packages URLs, or
-  dependencies.
-
-What's in PurlDB?
-=================
-
-The PurlDB project consists of these main tools:
-
-- PackageDB that is the database and reference model (based on ScanCode toolkit)
-  that contains package data with PURL (Package URLs) being a first class citizen and the primaty
-  key to access information.
-
-- MineCode that contains utilities to mine package repositories and populate the PackageDB
-
-- MatchCode that contains utilities to index package metadata and resources for
-  matching
-
-- MatchCode.io that provides code package and files matching functionalities for codebases
-
-- purldb-toolkit with its "purlcli" command line (CLI) utility and library to use the PurlDB, its
-  API and various related libraries.
-
-- ClearCode that contains utilities to mine Clearlydefined for package data.
-
diff --git a/docs/source/license.rst b/docs/source/license.rst
@@ -1,7 +1,9 @@
+:orphan:
+
 License
 =======
 
-Copyright (c) nexB Inc. and others. All rights reserved.
+Copyright (c) AboutCode, nexB Inc. and others. All rights reserved.
 
 purldb is a trademark of nexB Inc.
 
diff --git a/docs/source/matchcode/index.rst b/docs/source/matchcode/index.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 ===========
  Matchcode
 ===========
diff --git a/docs/source/purldb/index.rst b/docs/source/purldb/index.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 PURLdb
 ======
 
diff --git a/docs/source/testing.rst b/docs/source/testing.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _testing:
 
 Running tests

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`.. include:: ../../CHANGELOG.rst`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`.. _contributing:`
`2`	`4`
`3`	`5`	`Contributing to PurlDB`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`Funding`
`2`	`4`	`=======`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`Getting Started`
`2`	`4`	`===============`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`How-To-Guides`
`2`	`4`	`=============`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`===========`
`2`	`4`	`Matchcode`
`3`	`5`	`===========`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`PURLdb`
`2`	`4`	`======`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`.. _testing:`
`2`	`4`
`3`	`5`	`Running tests`