update docs

fix layout and title
opendataformat · Nov 26, 2024 · 4f0892c · 4f0892c
1 parent 6d31eef
commit 4f0892c
Show file tree

Hide file tree

Showing 35 changed files with 5,536 additions and 0 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/build/html/README.html b/docs/build/html/README.html
@@ -0,0 +1,166 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="./">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>opendataformat &#8212; OpenDataFormat 0.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
+    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
+    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
+    <link rel="stylesheet" type="text/css" href="_static/custom.css?v=18a6d809" />
+    <script src="_static/documentation_options.js?v=2709fde1"></script>
+    <script src="_static/doctools.js?v=9bcbadda"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+
+  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+
+
+
+  </head><body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+
+
+          <div class="body" role="main">
+
+  <section id="opendataformat">
+<h1>opendataformat<a class="headerlink" href="#opendataformat" title="Link to this heading">¶</a></h1>
+<section id="overview">
+<h2>Overview<a class="headerlink" href="#overview" title="Link to this heading">¶</a></h2>
+<p>The <code class="docutils literal notranslate"><span class="pre">opendataformat</span></code> package is specifically designed to facilitate
+the seamless utilization of the Open Data Format (ODF). It offers
+functionality to import data from the Open Data Format into a Python
+pandas data frame, as well as export data from a Pandas data frame to
+the Open Data Format. You can easily access comprehensive information
+about the dataset and variables in Python. This user-friendly approach
+ensures convenient exploration and utilization of dataset information
+within your preferred environment.</p>
+<p>For more comprehensive insights into the Open Data Format specification,
+please visit: <a class="reference external" href="https://opendataformat.github.io/specification">Open Data Format
+Specification</a>. This
+resource provides detailed documentation and profiles illustrating the
+storage locations of attributes within the Open Data Format, as well as
+within the native formats to which they will be converted. Additionally,
+you will have access to a practical example of <a class="reference external" href="https://git.soep.de/opendata/open-data-package">real data in the Open
+Data Format</a>.</p>
+</section>
+<section id="installation">
+<h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h2>
+<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="c1"># You can install the development version from GitHub:</span>
+<span class="n">pip</span> <span class="n">install</span> <span class="n">git</span><span class="o">+</span><span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">opendataformat</span><span class="o">/</span><span class="n">python</span><span class="o">-</span><span class="n">package</span><span class="o">-</span><span class="n">opendataformat</span><span class="o">.</span><span class="n">git</span>
+</pre></div>
+</div>
+</section>
+<section id="getting-started">
+<h2>Getting started<a class="headerlink" href="#getting-started" title="Link to this heading">¶</a></h2>
+<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">opendataformat</span> <span class="k">as</span> <span class="nn">odf</span>
+</pre></div>
+</div>
+<p>The opendataformat package consists of five main functions:</p>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">odf.read_odf()</span></code> to read an Open Data Format file in Pandas. This
+function takes an input parameter “path”, which is the path to the
+Open Data Format ZIP file.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">odf.docu_odf()</span></code> to display or retrieve metadata for a ODF data
+frame or a variable / column.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">odf.write_odf()</span></code> to write the Pandas Dataframe to an Open Data
+Format ZIP file. By specifying the dataframe input and providing the
+output directory path the function will generate a ZIP file
+containing the dataset as “data.csv” and “metadata.xml”.</p></li>
+</ul>
+<section id="multilingual-datasets">
+<h3>Multilingual Datasets<a class="headerlink" href="#multilingual-datasets" title="Link to this heading">¶</a></h3>
+<p>When working with a multilingual dataset, the <code class="docutils literal notranslate"><span class="pre">opendataformat</span></code> package
+provides the option to specify the language you want to work with for
+the main functions: <code class="docutils literal notranslate"><span class="pre">read_odf()</span></code>, <code class="docutils literal notranslate"><span class="pre">docu_odf()</span></code>, and <code class="docutils literal notranslate"><span class="pre">write_odf()</span></code>.</p>
+<p>You can achieve this by using the <code class="docutils literal notranslate"><span class="pre">languages</span></code> argument and setting it
+to either <code class="docutils literal notranslate"><span class="pre">all</span></code> to include all languages, or by specifying the
+language code such as <code class="docutils literal notranslate"><span class="pre">de</span></code> for German or <code class="docutils literal notranslate"><span class="pre">en</span></code> for English. This
+allows you to easily select the desired language for your dataset
+operations. The language codes are defined by the <a class="reference external" href="https://de.wikipedia.org/wiki/Liste_der_ISO-639-1-Codes">ISO
+639-1</a>.</p>
+</section>
+</section>
+<section id="getting-help">
+<h2>Getting help<a class="headerlink" href="#getting-help" title="Link to this heading">¶</a></h2>
+<p>If you encounter a clear bug, please file a minimal reproducible example
+on <strong>https://github.com/thartl-diw/py-package-opendataformat/issues</strong>.</p>
+</section>
+</section>
+
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="index.html">OpenDataFormat</a></h1>
+
+
+
+
+
+
+
+
+
+<search id="searchbox" style="display: none" role="search">
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="opendataformat.html">opendataformat package</a></li>
+</ul>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="index.html">Documentation overview</a><ul>
+  </ul></li>
+</ul>
+</div>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2024, Tom Hartl, Xiaoyao Han.
+
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
+
+      |
+      <a href="_sources/README.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+
+
+
+
+  </body>
+</html>
diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html
@@ -0,0 +1,102 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Overview: module code &#8212; OpenDataFormat 0.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
+    <link rel="stylesheet" type="text/css" href="../_static/custom.css?v=18a6d809" />
+    <script src="../_static/documentation_options.js?v=2709fde1"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+
+
+
+  </head><body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+
+
+          <div class="body" role="main">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="opendataformat/docu_odf.html">opendataformat.docu_odf</a></li>
+<li><a href="opendataformat/read_odf.html">opendataformat.read_odf</a></li>
+<li><a href="opendataformat/write_odf.html">opendataformat.write_odf</a></li>
+</ul>
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">OpenDataFormat</a></h1>
+
+
+
+
+
+
+
+
+
+<search id="searchbox" style="display: none" role="search">
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../opendataformat.html">opendataformat package</a></li>
+</ul>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+  </ul></li>
+</ul>
+</div>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2024, Tom Hartl, Xiaoyao Han.
+
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
+
+    </div>
+
+
+
+
+  </body>
+</html>