Skip to content
Snippets Groups Projects
Commit e7fbe803 authored by pinyili2's avatar pinyili2
Browse files

delete unwanted files

parent 77722b9c
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
.DS_Store deleted 100644 → 0
+ 0
− 0
View file @ 77722b9c
File deleted
docs/Makefile deleted 100644 → 0
+ 0
− 20
View file @ 77722b9c
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = arbdmodel
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)
docs/requirements.txt deleted 100644 → 0
+ 0
− 14
View file @ 77722b9c
Sphinx>=1.7.5
sphinx-autobuild>=0.7.1
sphinx-rtd-theme>=0.4.0
sphinxcontrib-napoleon>=0.6.1
sphinxcontrib-websupport>=1.1.0
MyST-Parser
furo
sphinx-copybutton
sphinx-autobuild
numpy
scipy
mdanalysis>=2.0.0
appdirs>=1.4
pandas>=1.0.0
docs/source/_templates/breadcrumbs.html deleted 100644 → 0
+ 0
− 4
View file @ 77722b9c
{%- extends "sphinx_rtd_theme/breadcrumbs.html" %}
{% block breadcrumbs_aside %}
{% endblock %}
docs/source/_templates/footer.html deleted 100644 → 0
+ 0
− 13
View file @ 77722b9c
{% extends "!footer.html" %}
{% block extrafooter %}
{{ super() }}
<div role="contentinfo">
<br>
This documentation was automatically generated by
<a href="https://gendocs.readthedocs.io/en/latest/">gendocs</a><br />
</div>
{% endblock %}
docs/source/conf.py deleted 100644 → 0
+ 0
− 192
View file @ 77722b9c
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
path = os.path.abspath('../..')
sys.path.insert(0, path)
# -- Automatic Doc Pages Generation ------------------------------------------
import arbdmodel # for documenting
from gendocs import Generator
# Automatically generate documentaion pages
Generator().DocumentPackages([arbdmodel],
'../../README.rst',
showprivate=True,
notify=False,
)
# -- Project information -----------------------------------------------------
project = 'arbdmodel'
copyright = ', '
author = ''
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = '0.0.0'
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'sphinxcontrib.napoleon',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'gendocsdoc'
# -- Options for LaTeX output ------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'arbdmodel.tex', 'arbdmodel Documentation',
'', 'manual'),
]
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'arbdmodel', 'arbdmodel Documentation',
[author], 1)
]
# -- Options for Texinfo output ----------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'arbdmodel', 'arbdmodel Documentation',
author, 'arbdmodel', 'One line description of project.',
'Miscellaneous'),
]
# -- Extension configuration -------------------------------------------------
# -- Options for intersphinx extension ---------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
# -- Options for todo extension ----------------------------------------------
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
setup.py deleted 100644 → 0
+ 0
− 30
View file @ 77722b9c
"""``arbdmodel``: A simple Python package with automatic documentation
"""
import setuptools
__version__ = '0.0.0'
with open("README.rst", "r") as f:
long_description = f.read()
setuptools.setup(
name="arbdmodel",
version=__version__,
author="",
author_email="",
description="A simple Python package with automatic documentation",
long_description=long_description,
long_description_content_type="text/x-rst",
url="https://github.com//arbdmodel",
packages=setuptools.find_packages(),
install_requires=[
# TODO: add dependencies
],
classifiers=(
"Programming Language :: Python",
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
'Natural Language :: English',
),
)
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment