Skip to content

Commit

Permalink
Deploying to gh-pages from @ 6211083 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
deveaud-m committed Jan 22, 2024
1 parent d269934 commit 89de693
Show file tree
Hide file tree
Showing 55 changed files with 2,476 additions and 14,444 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 14f142167db824293318aadc8cda06ec
config: 122d9b116885f1154a96ffb8fcc70cbc
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/enums.doctree
Binary file not shown.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified .doctrees/exceptions.doctree
Binary file not shown.
Binary file modified .doctrees/folders.doctree
Binary file not shown.
Binary file modified .doctrees/foss_cli.doctree
Binary file not shown.
Binary file modified .doctrees/fossology.doctree
Binary file not shown.
Binary file modified .doctrees/groups.doctree
Binary file not shown.
Binary file modified .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/items.doctree
Binary file not shown.
Binary file modified .doctrees/jobs.doctree
Binary file not shown.
Binary file modified .doctrees/license.doctree
Binary file not shown.
Binary file modified .doctrees/logging.doctree
Binary file not shown.
Binary file modified .doctrees/obj.doctree
Binary file not shown.
Binary file modified .doctrees/report.doctree
Binary file not shown.
Binary file modified .doctrees/sample_workflow.doctree
Binary file not shown.
Binary file modified .doctrees/uploads.doctree
Binary file not shown.
Binary file added .doctrees/users.doctree
Binary file not shown.
8 changes: 8 additions & 0 deletions _sources/enums.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
===============
Fossology Enums
===============

The Python enums derived from the REST data.

.. automodule:: fossology.enums
:members:
3 changes: 3 additions & 0 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,14 @@ Welcome to fossology's documentation!
fossology
folders
groups
items
license
uploads
jobs
report
users
obj
enums
exceptions
logging
sample_workflow
Expand Down
8 changes: 8 additions & 0 deletions _sources/items.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
===============
Fossology Items
===============

Methods used to access "items/" endpoints.

.. automodule:: fossology.items
:members:
6 changes: 3 additions & 3 deletions _sources/sample_workflow.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ Needed imports and Variables
>>> from getpass import getpass
>>> import requests
>>> from fossology import Fossology, fossology_token
>>> from fossology.obj import Group, AccessLevel, TokenScope
>>> from fossology.obj import Group
>>> from fossology.enums import AccessLevel, TokenScope
>>> from fossology.exceptions import FossologyApiError
>>> FOSSOLOGY_SERVER = "http://fossology/repo"
>>> os.environ["FOSSOLOGY_USER"] = "fossy"
Expand Down Expand Up @@ -65,8 +66,7 @@ Login to the Fossology Server
Create the Fossology Instance.


>>> # The username is only needed for Fossology API version < 1.2.3
>>> foss = Fossology(FOSSOLOGY_SERVER, token, name=os.environ["FOSSOLOGY_USER"])
>>> foss = Fossology(FOSSOLOGY_SERVER, token)
>>> print(f"Logged in as user {foss.user.name}")
Logged in as user fossy

Expand Down
8 changes: 8 additions & 0 deletions _sources/users.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
===============
Fossology Users
===============

Methods used to access "users/" endpoints.

.. automodule:: fossology.users
:members:
74 changes: 47 additions & 27 deletions _static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -222,7 +222,7 @@ table.modindextable td {
/* -- general body styles --------------------------------------------------- */

div.body {
min-width: 450px;
min-width: 360px;
max-width: 800px;
}

Expand All @@ -237,14 +237,8 @@ a.headerlink {
visibility: hidden;
}

a.brackets:before,
span.brackets > a:before{
content: "[";
}

a.brackets:after,
span.brackets > a:after {
content: "]";
a:visited {
color: #551A8B;
}

h1:hover > a.headerlink,
Expand Down Expand Up @@ -335,12 +329,16 @@ p.sidebar-title {
font-weight: bold;
}

nav.contents,
aside.topic,
div.admonition, div.topic, blockquote {
clear: left;
}

/* -- topics ---------------------------------------------------------------- */

nav.contents,
aside.topic,
div.topic {
border: 1px solid #ccc;
padding: 7px;
Expand Down Expand Up @@ -379,13 +377,17 @@ div.body p.centered {

div.sidebar > :last-child,
aside.sidebar > :last-child,
nav.contents > :last-child,
aside.topic > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
}

div.sidebar::after,
aside.sidebar::after,
nav.contents::after,
aside.topic::after,
div.topic::after,
div.admonition::after,
blockquote::after {
Expand Down Expand Up @@ -428,10 +430,6 @@ table.docutils td, table.docutils th {
border-bottom: 1px solid #aaa;
}

table.footnote td, table.footnote th {
border: 0 !important;
}

th {
text-align: left;
padding-right: 5px;
Expand Down Expand Up @@ -615,19 +613,26 @@ ul.simple p {
margin-bottom: 0;
}

dl.footnote > dt,
dl.citation > dt {
aside.footnote > span,
div.citation > span {
float: left;
margin-right: 0.5em;
}

dl.footnote > dd,
dl.citation > dd {
aside.footnote > span:last-of-type,
div.citation > span:last-of-type {
padding-right: 0.5em;
}
aside.footnote > p {
margin-left: 2em;
}
div.citation > p {
margin-left: 4em;
}
aside.footnote > p:last-of-type,
div.citation > p:last-of-type {
margin-bottom: 0em;
}

dl.footnote > dd:after,
dl.citation > dd:after {
aside.footnote > p:last-of-type:after,
div.citation > p:last-of-type:after {
content: "";
clear: both;
}
Expand All @@ -644,10 +649,6 @@ dl.field-list > dt {
padding-right: 5px;
}

dl.field-list > dt:after {
content: ":";
}

dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;
Expand All @@ -673,6 +674,16 @@ dd {
margin-left: 30px;
}

.sig dd {
margin-top: 0px;
margin-bottom: 0px;
}

.sig dl {
margin-top: 0px;
margin-bottom: 0px;
}

dl > dd:last-child,
dl > dd:last-child > :last-child {
margin-bottom: 0;
Expand Down Expand Up @@ -741,6 +752,14 @@ abbr, acronym {
cursor: help;
}

.translated {
background-color: rgba(207, 255, 207, 0.2)
}

.untranslated {
background-color: rgba(255, 207, 207, 0.2)
}

/* -- code displays --------------------------------------------------------- */

pre {
Expand All @@ -757,6 +776,7 @@ span.pre {
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
white-space: nowrap;
}

div[class*="highlight-"] {
Expand Down
Loading

0 comments on commit 89de693

Please sign in to comment.