Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 43 additions & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,49 @@ BUILDDIR = build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile
# Clean build directory
clean:
rm -rf $(BUILDDIR)/*

# Build HTML documentation
html:
$(SPHINXBUILD) -b html $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

# Build HTML and open in browser
serve: html
@echo "Opening documentation in browser..."
@if command -v open >/dev/null 2>&1; then \
open $(BUILDDIR)/html/index.html; \
elif command -v xdg-open >/dev/null 2>&1; then \
xdg-open $(BUILDDIR)/html/index.html; \
else \
echo "Please open $(BUILDDIR)/html/index.html in your browser"; \
fi

# Build PDF documentation
pdf:
$(SPHINXBUILD) -b latex $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

# Check for broken links
linkcheck:
$(SPHINXBUILD) -b linkcheck $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/linkcheck
@echo
@echo "Link check finished; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."

# Spell check (requires sphinxcontrib-spelling)
spelling:
$(SPHINXBUILD) -b spelling $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/spelling
@echo
@echo "Spell check finished; look for any errors in the above output " \
"or in $(BUILDDIR)/spelling/output.txt."

.PHONY: help Makefile clean html serve pdf linkcheck spelling

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 06e842708d34c14d7ed3fe2bd8dd5165
config: 5f692cdea773b403afcc7068483ecb67
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/build/html/.doctrees/advanced_usage.doctree
Binary file not shown.
Binary file added docs/build/html/.doctrees/api.doctree
Binary file not shown.
Binary file added docs/build/html/.doctrees/configuration.doctree
Binary file not shown.
Binary file added docs/build/html/.doctrees/environment.pickle
Binary file not shown.
Binary file added docs/build/html/.doctrees/examples.doctree
Binary file not shown.
Binary file added docs/build/html/.doctrees/formats.doctree
Binary file not shown.
Binary file added docs/build/html/.doctrees/index.doctree
Binary file not shown.
Binary file added docs/build/html/.doctrees/installation.doctree
Binary file not shown.
Binary file added docs/build/html/.doctrees/quickstart.doctree
Binary file not shown.
Empty file removed docs/build/html/.nojekyll
Empty file.
600 changes: 600 additions & 0 deletions docs/build/html/_modules/atio/core.html

Large diffs are not rendered by default.

229 changes: 229 additions & 0 deletions docs/build/html/_modules/atio/plugins.html

Large diffs are not rendered by default.

248 changes: 248 additions & 0 deletions docs/build/html/_modules/atio/utils.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<html class="writer-html5" lang="ko" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Modules &mdash; atio documentation</title>
<title>개요: 모듈 코드 &mdash; Atio 2.0.0 문서</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />


<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../_static/documentation_options.js?v=86ec957b"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/translations.js?v=afa94a99"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="atio" href="_autosummary/atio.html" />
<link rel="prev" title="Atio Documentation" href="../index.html" />
<link rel="index" title="색인" href="../genindex.html" />
<link rel="search" title="검색" href="../search.html" />
</head>

<body class="wy-body-for-nav">
Expand All @@ -32,7 +30,7 @@


<a href="../index.html" class="icon icon-home">
atio
Atio
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand All @@ -42,12 +40,17 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Modules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/atio.html">atio</a></li>
<p class="caption" role="heading"><span class="caption-text">사용자 가이드:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">설치 가이드</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quickstart.html">빠른 시작</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples.html">사용 예제</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced_usage.html">고급 사용법</a></li>
</ul>
</li>
<p class="caption" role="heading"><span class="caption-text">API 참조:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api.html">API 참조</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration.html">설정 및 구성</a></li>
</ul>

</div>
Expand All @@ -56,47 +59,37 @@

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">atio</a>
<a href="../index.html">Atio</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Modules</li>
<li class="breadcrumb-item active">개요: 모듈 코드</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/modules.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="modules">
<h1>Modules<a class="headerlink" href="#modules" title="Link to this heading"></a></h1>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/atio.html#module-atio" title="atio"><code class="xref py py-obj docutils literal notranslate"><span class="pre">atio</span></code></a></p></td>
<td><p>Atio: 안전한 원자적 파일 쓰기 라이브러리</p></td>
</tr>
</tbody>
</table>
</section>

<h1>코드를 확인할 수 있는 모든 모듈</h1>
<ul><li><a href="atio/core.html">atio.core</a></li>
<li><a href="atio/plugins.html">atio.plugins</a></li>
<li><a href="atio/utils.html">atio.utils</a></li>
</ul>

</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../index.html" class="btn btn-neutral float-left" title="Atio Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="_autosummary/atio.html" class="btn btn-neutral float-right" title="atio" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<footer>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2025, jujangchoi.</p>
<p>&#169; Copyright 2025, Seo Jae Oh.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Expand Down
Loading