Skip to content

Commit 5644d17

Browse files
hschellmanhschellman
committed
Merge branch 'gh-pages' of https://github.com/DUNE/DataCatalogDocs into develop
2 parents 4326ffe + e3eabc7 commit 5644d17

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+20434
-0
lines changed

‎.buildinfo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 7490dae6b1da145cd1da4b6f1ce5a929
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎.nojekyll‎

Whitespace-only changes.

‎Ack.html‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
2+
<!DOCTYPE html>
3+
4+
<html lang="en">
5+
<head>
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8+
<title>Acknowledgements &#8212; DataCatalogDocs 0.2 documentation</title>
9+
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
10+
<link rel="stylesheet" type="text/css" href="_static/nature.css" />
11+
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
12+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
13+
<script src="_static/jquery.js"></script>
14+
<script src="_static/underscore.js"></script>
15+
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
16+
<script src="_static/doctools.js"></script>
17+
<script src="_static/sphinx_highlight.js"></script>
18+
<link rel="canonical" href="https://dune.github.io/DataCatalogDocs/Ack.html" />
19+
<link rel="index" title="Index" href="genindex.html" />
20+
<link rel="search" title="Search" href="search.html" />
21+
<link rel="prev" title="Notes on sphinx" href="Notes.html" />
22+
</head><body>
23+
<div class="related" role="navigation" aria-label="related navigation">
24+
<h3>Navigation</h3>
25+
<ul>
26+
<li class="right" style="margin-right: 10px">
27+
<a href="genindex.html" title="General Index"
28+
accesskey="I">index</a></li>
29+
<li class="right" >
30+
<a href="Notes.html" title="Notes on sphinx"
31+
accesskey="P">previous</a> |</li>
32+
<li class="nav-item nav-item-0"><a href="index.html">DataCatalogDocs 0.2 documentation</a> &#187;</li>
33+
<li class="nav-item nav-item-this"><a href="">Acknowledgements</a></li>
34+
</ul>
35+
</div>
36+
37+
<div class="document">
38+
<div class="documentwrapper">
39+
<div class="bodywrapper">
40+
<div class="body" role="main">
41+
42+
<div class="section" id="acknowledgements">
43+
<h1>Acknowledgements<a class="headerlink" href="#acknowledgements" title="Permalink to this heading"></a></h1>
44+
<p>The creation of this documentation was supported by the National Science Foundation Awards 2112727 and 2410721, Dept. of Energy Award DE‐SC-0022271 and Fermi National Accelerator Laboratory.</p>
45+
</div>
46+
47+
48+
<div class="clearer"></div>
49+
</div>
50+
</div>
51+
</div>
52+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
53+
<div class="sphinxsidebarwrapper">
54+
<div>
55+
<h4>Previous topic</h4>
56+
<p class="topless"><a href="Notes.html"
57+
title="previous chapter">Notes on sphinx</a></p>
58+
</div>
59+
<div role="note" aria-label="source link">
60+
<h3>This Page</h3>
61+
<ul class="this-page-menu">
62+
<li><a href="_sources/Ack.rst.txt"
63+
rel="nofollow">Show Source</a></li>
64+
</ul>
65+
</div>
66+
<div id="searchbox" style="display: none" role="search">
67+
<h3 id="searchlabel">Quick search</h3>
68+
<div class="searchformwrapper">
69+
<form class="search" action="search.html" method="get">
70+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
71+
<input type="submit" value="Go" />
72+
</form>
73+
</div>
74+
</div>
75+
<script>document.getElementById('searchbox').style.display = "block"</script>
76+
</div>
77+
</div>
78+
<div class="clearer"></div>
79+
</div>
80+
<div class="related" role="navigation" aria-label="related navigation">
81+
<h3>Navigation</h3>
82+
<ul>
83+
<li class="right" style="margin-right: 10px">
84+
<a href="genindex.html" title="General Index"
85+
>index</a></li>
86+
<li class="right" >
87+
<a href="Notes.html" title="Notes on sphinx"
88+
>previous</a> |</li>
89+
<li class="nav-item nav-item-0"><a href="index.html">DataCatalogDocs 0.2 documentation</a> &#187;</li>
90+
<li class="nav-item nav-item-this"><a href="">Acknowledgements</a></li>
91+
</ul>
92+
</div>
93+
<div class="footer" role="contentinfo">
94+
&#169; Copyright 2023, Fermi National Accelerator Laboratory.
95+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
96+
</div>
97+
</body>
98+
</html>

‎Intro.html‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
2+
<!DOCTYPE html>
3+
4+
<html lang="en">
5+
<head>
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8+
<title>Introduction &#8212; DataCatalogDocs 0.2 documentation</title>
9+
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
10+
<link rel="stylesheet" type="text/css" href="_static/nature.css" />
11+
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
12+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
13+
<script src="_static/jquery.js"></script>
14+
<script src="_static/underscore.js"></script>
15+
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
16+
<script src="_static/doctools.js"></script>
17+
<script src="_static/sphinx_highlight.js"></script>
18+
<link rel="canonical" href="https://dune.github.io/DataCatalogDocs/Intro.html" />
19+
<link rel="index" title="Index" href="genindex.html" />
20+
<link rel="search" title="Search" href="search.html" />
21+
<link rel="next" title="Sam to Metacat Conversion guide" href="sam2metacat.html" />
22+
<link rel="prev" title="DUNE Data Catalog Documentation" href="index.html" />
23+
</head><body>
24+
<div class="related" role="navigation" aria-label="related navigation">
25+
<h3>Navigation</h3>
26+
<ul>
27+
<li class="right" style="margin-right: 10px">
28+
<a href="genindex.html" title="General Index"
29+
accesskey="I">index</a></li>
30+
<li class="right" >
31+
<a href="sam2metacat.html" title="Sam to Metacat Conversion guide"
32+
accesskey="N">next</a> |</li>
33+
<li class="right" >
34+
<a href="index.html" title="DUNE Data Catalog Documentation"
35+
accesskey="P">previous</a> |</li>
36+
<li class="nav-item nav-item-0"><a href="index.html">DataCatalogDocs 0.2 documentation</a> &#187;</li>
37+
<li class="nav-item nav-item-this"><a href="">Introduction</a></li>
38+
</ul>
39+
</div>
40+
41+
<div class="document">
42+
<div class="documentwrapper">
43+
<div class="bodywrapper">
44+
<div class="body" role="main">
45+
46+
<div class="section" id="introduction">
47+
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this heading"></a></h1>
48+
<p>These pages provide documentation on DUNE data catalog systems.</p>
49+
<p>DUNE is transitioning away from using <cite>samweb</cite> to a system based on <cite>metacat</cite> and <cite>rucio</cite></p>
50+
<p>We provide example code for the transition</p>
51+
</div>
52+
53+
54+
<div class="clearer"></div>
55+
</div>
56+
</div>
57+
</div>
58+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
59+
<div class="sphinxsidebarwrapper">
60+
<div>
61+
<h4>Previous topic</h4>
62+
<p class="topless"><a href="index.html"
63+
title="previous chapter">DUNE Data Catalog Documentation</a></p>
64+
</div>
65+
<div>
66+
<h4>Next topic</h4>
67+
<p class="topless"><a href="sam2metacat.html"
68+
title="next chapter">Sam to Metacat Conversion guide</a></p>
69+
</div>
70+
<div role="note" aria-label="source link">
71+
<h3>This Page</h3>
72+
<ul class="this-page-menu">
73+
<li><a href="_sources/Intro.rst.txt"
74+
rel="nofollow">Show Source</a></li>
75+
</ul>
76+
</div>
77+
<div id="searchbox" style="display: none" role="search">
78+
<h3 id="searchlabel">Quick search</h3>
79+
<div class="searchformwrapper">
80+
<form class="search" action="search.html" method="get">
81+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
82+
<input type="submit" value="Go" />
83+
</form>
84+
</div>
85+
</div>
86+
<script>document.getElementById('searchbox').style.display = "block"</script>
87+
</div>
88+
</div>
89+
<div class="clearer"></div>
90+
</div>
91+
<div class="related" role="navigation" aria-label="related navigation">
92+
<h3>Navigation</h3>
93+
<ul>
94+
<li class="right" style="margin-right: 10px">
95+
<a href="genindex.html" title="General Index"
96+
>index</a></li>
97+
<li class="right" >
98+
<a href="sam2metacat.html" title="Sam to Metacat Conversion guide"
99+
>next</a> |</li>
100+
<li class="right" >
101+
<a href="index.html" title="DUNE Data Catalog Documentation"
102+
>previous</a> |</li>
103+
<li class="nav-item nav-item-0"><a href="index.html">DataCatalogDocs 0.2 documentation</a> &#187;</li>
104+
<li class="nav-item nav-item-this"><a href="">Introduction</a></li>
105+
</ul>
106+
</div>
107+
<div class="footer" role="contentinfo">
108+
&#169; Copyright 2023, Fermi National Accelerator Laboratory.
109+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
110+
</div>
111+
</body>
112+
</html>

‎Notes.html‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
2+
<!DOCTYPE html>
3+
4+
<html lang="en">
5+
<head>
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8+
<title>Notes on sphinx &#8212; DataCatalogDocs 0.2 documentation</title>
9+
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
10+
<link rel="stylesheet" type="text/css" href="_static/nature.css" />
11+
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
12+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
13+
<script src="_static/jquery.js"></script>
14+
<script src="_static/underscore.js"></script>
15+
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
16+
<script src="_static/doctools.js"></script>
17+
<script src="_static/sphinx_highlight.js"></script>
18+
<link rel="canonical" href="https://dune.github.io/DataCatalogDocs/Notes.html" />
19+
<link rel="index" title="Index" href="genindex.html" />
20+
<link rel="search" title="Search" href="search.html" />
21+
<link rel="next" title="Acknowledgements" href="Ack.html" />
22+
<link rel="prev" title="Related documentation" href="related.html" />
23+
</head><body>
24+
<div class="related" role="navigation" aria-label="related navigation">
25+
<h3>Navigation</h3>
26+
<ul>
27+
<li class="right" style="margin-right: 10px">
28+
<a href="genindex.html" title="General Index"
29+
accesskey="I">index</a></li>
30+
<li class="right" >
31+
<a href="Ack.html" title="Acknowledgements"
32+
accesskey="N">next</a> |</li>
33+
<li class="right" >
34+
<a href="related.html" title="Related documentation"
35+
accesskey="P">previous</a> |</li>
36+
<li class="nav-item nav-item-0"><a href="index.html">DataCatalogDocs 0.2 documentation</a> &#187;</li>
37+
<li class="nav-item nav-item-this"><a href="">Notes on sphinx</a></li>
38+
</ul>
39+
</div>
40+
41+
<div class="document">
42+
<div class="documentwrapper">
43+
<div class="bodywrapper">
44+
<div class="body" role="main">
45+
46+
<div class="section" id="notes-on-sphinx">
47+
<h1>Notes on sphinx<a class="headerlink" href="#notes-on-sphinx" title="Permalink to this heading"></a></h1>
48+
<p>This was my first sphinx project.</p>
49+
<p>I started with the <a class="reference external" href="https://www.sphinx-doc.org/en/master/tutorial/getting-started.html">https://www.sphinx-doc.org/en/master/tutorial/getting-started.html</a> tutorial so I have a similar structure.</p>
50+
<p>I used the napoleon theme that Igor Mandrichenko used from <a class="reference external" href="https://metacat.readthedocs.io/en/latest/">https://metacat.readthedocs.io/en/latest/</a></p>
51+
<div class="section" id="rst-format">
52+
<h2>rst format<a class="headerlink" href="#rst-format" title="Permalink to this heading"></a></h2>
53+
<p><a class="reference external" href="https://docutils.sourceforge.io/docs/user/rst/quickstart.html">https://docutils.sourceforge.io/docs/user/rst/quickstart.html</a></p>
54+
<p>Not my favorite -</p>
55+
<blockquote>
56+
<div><ul class="simple">
57+
<li><p>the need to keep track of indentation and blank lines with poor error messages is painful</p></li>
58+
<li><p>indentation differences when adding comments to code others wrote can be interesting</p></li>
59+
</ul>
60+
</div></blockquote>
61+
</div>
62+
<div class="section" id="github-actions">
63+
<h2>Github actions<a class="headerlink" href="#github-actions" title="Permalink to this heading"></a></h2>
64+
<p>I set up github actions to build on my github page hschellman/DataChallengeWork-loginator which is based on Jake Calcutt’s data dispatcher test system</p>
65+
<p>The github actions had some issues:</p>
66+
<blockquote>
67+
<div><ul>
68+
<li><p>It assumed the code was in main - I had to move to develop</p></li>
69+
<li><p>I had to add a gh-pages branch by hand</p></li>
70+
<li><p>I adapted <a class="reference external" href="https://github.com/ammaraskar/sphinx-action">https://github.com/ammaraskar/sphinx-action</a> from Ammar Askar</p></li>
71+
<li><p>The action can be found at <a class="reference external" href="https://github.com/hschellman/DataChallengeWork-loginator/blob/develop/.github/workflows/sphinx.yml">sphinx.yml</a></p></li>
72+
<li><p>I was not able to get the programoutput extension to work as adding a pip install for it did not work. So command line syntax is added by hand.</p></li>
73+
<li><p>I had to add a</p>
74+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">autodoc_mock_imports</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;metacat&quot;</span><span class="p">,</span><span class="s2">&quot;samweb_client&quot;</span><span class="p">,</span><span class="s2">&quot;data_dispatcher&quot;</span><span class="p">]</span>
75+
</pre></div>
76+
</div>
77+
<p>to the <cite>conf.py</cite> to avoid errors due to imports of external code. I just got blanks otherwise.</p>
78+
</li>
79+
</ul>
80+
</div></blockquote>
81+
</div>
82+
<div class="section" id="google-indexing-notes">
83+
<h2>Google indexing Notes<a class="headerlink" href="#google-indexing-notes" title="Permalink to this heading"></a></h2>
84+
<p># Go to <a class="reference external" href="https://search.google.com/search-console/welcome?hl=en&amp;utm_source=wmx&amp;utm_medium=deprecation-pane&amp;utm_content=home">Google Search Console</a></p>
85+
<p># choose URL prefix and enter your top level URL you will get back a</p>
86+
<p># I github added build/html (just the directories) to github to be in the same directory as <cite>index.html</cite> and then placed the key file I got from google in that directory.</p>
87+
<p># I then added that file to github, committed and pushed.</p>
88+
<p># Once the action to build the docs go to the search console again and go to URL inspection. You should be able to check that the URL exists and request indexing.</p>
89+
</div>
90+
</div>
91+
92+
93+
<div class="clearer"></div>
94+
</div>
95+
</div>
96+
</div>
97+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
98+
<div class="sphinxsidebarwrapper">
99+
<div>
100+
<h3><a href="index.html">Table of Contents</a></h3>
101+
<ul>
102+
<li><a class="reference internal" href="#">Notes on sphinx</a><ul>
103+
<li><a class="reference internal" href="#rst-format">rst format</a></li>
104+
<li><a class="reference internal" href="#github-actions">Github actions</a></li>
105+
<li><a class="reference internal" href="#google-indexing-notes">Google indexing Notes</a></li>
106+
</ul>
107+
</li>
108+
</ul>
109+
110+
</div>
111+
<div>
112+
<h4>Previous topic</h4>
113+
<p class="topless"><a href="related.html"
114+
title="previous chapter">Related documentation</a></p>
115+
</div>
116+
<div>
117+
<h4>Next topic</h4>
118+
<p class="topless"><a href="Ack.html"
119+
title="next chapter">Acknowledgements</a></p>
120+
</div>
121+
<div role="note" aria-label="source link">
122+
<h3>This Page</h3>
123+
<ul class="this-page-menu">
124+
<li><a href="_sources/Notes.rst.txt"
125+
rel="nofollow">Show Source</a></li>
126+
</ul>
127+
</div>
128+
<div id="searchbox" style="display: none" role="search">
129+
<h3 id="searchlabel">Quick search</h3>
130+
<div class="searchformwrapper">
131+
<form class="search" action="search.html" method="get">
132+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
133+
<input type="submit" value="Go" />
134+
</form>
135+
</div>
136+
</div>
137+
<script>document.getElementById('searchbox').style.display = "block"</script>
138+
</div>
139+
</div>
140+
<div class="clearer"></div>
141+
</div>
142+
<div class="related" role="navigation" aria-label="related navigation">
143+
<h3>Navigation</h3>
144+
<ul>
145+
<li class="right" style="margin-right: 10px">
146+
<a href="genindex.html" title="General Index"
147+
>index</a></li>
148+
<li class="right" >
149+
<a href="Ack.html" title="Acknowledgements"
150+
>next</a> |</li>
151+
<li class="right" >
152+
<a href="related.html" title="Related documentation"
153+
>previous</a> |</li>
154+
<li class="nav-item nav-item-0"><a href="index.html">DataCatalogDocs 0.2 documentation</a> &#187;</li>
155+
<li class="nav-item nav-item-this"><a href="">Notes on sphinx</a></li>
156+
</ul>
157+
</div>
158+
<div class="footer" role="contentinfo">
159+
&#169; Copyright 2023, Fermi National Accelerator Laboratory.
160+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
161+
</div>
162+
</body>
163+
</html>

0 commit comments

Comments
 (0)