Skip to content

Commit ea2c58b

Browse files
committed
Fix docs build errors
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
1 parent 486db92 commit ea2c58b

6 files changed

Lines changed: 68 additions & 10 deletions

File tree

docs/source/PIPELINES-AVID.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
.. _pipelines_avid:
2+
3+
Pipelines AVID Mapping
4+
=========================
5+
16
.. list-table:: Pipeline AVID Mapping
27
:header-rows: 1
38
:widths: 35 65

docs/source/SOURCES.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
.. _sources:
2+
3+
Sources
4+
=======
5+
16
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
27
|Importer Name | Data Source |Ecosystems Covered |
38
+================+======================================================================================================+====================================================+

docs/source/api_v3_usage.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _api_v3_usage:
2+
13
Package Endpoint
24
================
35

docs/source/faq.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _faq:
2+
13
FAQ
24
====
35

docs/source/index.rst

Lines changed: 52 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,47 @@
1+
.. toctree::
2+
:hidden:
3+
:maxdepth: 2
4+
:caption: Getting Started
5+
6+
introduction
7+
installation
8+
user-interface
9+
api
10+
api-admin
11+
api_v3_usage
12+
13+
.. toctree::
14+
:hidden:
15+
:maxdepth: 2
16+
:caption: Tutorials
17+
18+
tutorial_add_importer_pipeline
19+
tutorial_add_improver_pipeline
20+
21+
.. toctree::
22+
:hidden:
23+
:maxdepth: 2
24+
:caption: Reference
25+
26+
reference_importer_overview
27+
reference_improver_overview
28+
reference_framework_overview
29+
reference_model_overview
30+
command-line-interface
31+
importers_link
32+
PIPELINES-AVID
33+
SOURCES
34+
35+
.. toctree::
36+
:hidden:
37+
:maxdepth: 1
38+
:caption: Misc
39+
40+
faq
41+
misc
42+
soc_gsoc21
43+
contributing
44+
145
VulnerableCode Documentation
246
============================
347

@@ -25,11 +69,11 @@ Getting started
2569
Start here if you are new to VulnerableCode.
2670

2771
- :ref:`introduction`
28-
- :ref:`user_interface`
72+
- :ref:`user-interface`
2973
- :ref:`installation`
3074
- :ref:`api`
31-
- :ref:`api-admin`
32-
- :ref:`api_v3_usage.rst`
75+
- :ref:`api_admin`
76+
- :ref:`api_v3_usage`
3377
- :ref:`contributing`
3478

3579
.. rst-class:: column column2 top-right
@@ -49,14 +93,14 @@ Reference Docs
4993

5094
Reference documentation for VulnerableCode features and customizations.
5195

52-
- :ref:`reference_importer_overview`
53-
- :ref:`reference_improver_overview`
96+
- :ref:`importer-overview`
97+
- :ref:`improver-overview`
5498
- :ref:`reference_framework_overview`
5599
- :ref:`reference_model_overview`
56100
- :ref:`command_line_interface`
57101
- :ref:`importers_link`
58-
- :ref:`PIPELINES-AVID.rst`
59-
- :ref:`SOURCES.rst`
102+
- :ref:`pipelines_avid`
103+
- :ref:`sources`
60104

61105
.. rst-class:: column column2 bottom-right
62106

@@ -71,11 +115,9 @@ Misc
71115
~~~~~~~~~~~~~~~
72116

73117
- :ref:`faq`
74-
- :ref:`misc`
118+
- :ref:`miscellaneous`
75119
- :ref:`soc_gsoc21`
76120

77-
.. include:: improve-docs.rst
78-
79121

80122
Indices and tables
81123
==================

docs/source/soc_gsoc21.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _soc_gsoc21:
2+
13
Google Summer of Code 2021 Final Report
24
============================================
35

0 commit comments

Comments
 (0)