Skip to content

Commit

Permalink
Renamed package to ordflow due to naming conflict
Browse files Browse the repository at this point in the history
  • Loading branch information
ssomnath committed Apr 25, 2022
1 parent 386d81d commit c1ded2d
Show file tree
Hide file tree
Showing 8 changed files with 29 additions and 528 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
dflow
=====
ordflow
=======

Python interface to ORNL's `DataFlow <https://dataflow.ornl.gov>`_

Expand Down
16 changes: 8 additions & 8 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import shutil
import sphinx_rtd_theme
sys.path.insert(0, os.path.abspath('../..'))
from dflow import __version__ as dflow_version
from ordflow import __version__ as dflow_version

# - Copy over examples folder to docs/source
# This makes it so that nbsphinx properly loads the notebook images
Expand All @@ -42,7 +42,7 @@

# -- Project information -----------------------------------------------------

project = 'dflow'
project = 'ordflow'
copyright = '2020, Suhas Somnath and Greg Shutt'
author = 'Suhas Somnath and Greg Shutt'

Expand Down Expand Up @@ -179,7 +179,7 @@

# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
html_title = u'dflow ' + dflow_version
html_title = u'ordflow ' + dflow_version

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
Expand Down Expand Up @@ -271,7 +271,7 @@
# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'dflowdoc'
htmlhelp_basename = 'ordflowdoc'


# -- Options for LaTeX output ------------------------------------------------
Expand All @@ -298,7 +298,7 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'dflow.tex', 'dflow Documentation',
(master_doc, 'ordflow.tex', 'ordflow Documentation',
'Pycroscopy contributors', 'manual'),
]

Expand Down Expand Up @@ -327,7 +327,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'dflow', 'dflow Documentation',
(master_doc, 'ordflow', 'ordflow Documentation',
[author], 1)
]

Expand All @@ -338,8 +338,8 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'dflow', 'dflow Documentation',
author, 'dflow',
(master_doc, 'ordflow', 'ordflow Documentation',
author, 'ordflow',
'Python interface to ORNL DataFlow',
'Miscellaneous'),
]
Expand Down
12 changes: 6 additions & 6 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
=====
dflow
=====
=======
ordflow
=======

**Python interface to ORNL's DataFlow**

Jump to `GitHub project page <https://github.com/ORNL/dflow>`_
Jump to `GitHub project page <https://github.com/ORNL/ordflow>`_

**Installation:**

.. code:: bash
pip install dflow
pip install ordflow
API
---
Expand All @@ -24,7 +24,7 @@ API
:template: custom-module-template.rst
:recursive:

dflow
ordflow

* :ref:`modindex`

Expand Down
Loading

0 comments on commit c1ded2d

Please sign in to comment.