From 83b260167ff33d11b153ee442c560d4c4fb28912 Mon Sep 17 00:00:00 2001 From: Niru Maheswaranathan Date: Sat, 17 May 2025 11:13:01 -0700 Subject: [PATCH] Update docs to use jetplot --- docs/Makefile | 8 ++++---- docs/conf.py | 20 ++++++++++---------- docs/index.rst | 6 +++--- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 81e901e..80076b7 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -87,9 +87,9 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/jetpack.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/jetplot.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/jetpack.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/jetplot.qhc" applehelp: $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp @@ -104,8 +104,8 @@ devhelp: @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/jetpack" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/jetpack" + @echo "# mkdir -p $$HOME/.local/share/devhelp/jetplot" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/jetplot" @echo "# devhelp" epub: diff --git a/docs/conf.py b/docs/conf.py index f6eca22..4e3107c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# jetpack documentation build configuration file, created by +# jetplot documentation build configuration file, created by # sphinx-quickstart on Fri Oct 2 14:49:15 2015. # # This file is execfile()d with the current directory set to its @@ -12,7 +12,7 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import jetpack +import jetplot # 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 @@ -51,7 +51,7 @@ master_doc = 'index' # General information about the project. -project = u'jetpack' +project = u'jetplot' copyright = u'2015, Niru Maheswaranathan' author = u'Niru Maheswaranathan' @@ -60,9 +60,9 @@ # built documents. # # The short X.Y version. -version = jetpack.__version__ +version = jetplot.__version__ # The full version, including alpha/beta/rc tags. -release = jetpack.__version__ +release = jetplot.__version__ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -205,7 +205,7 @@ #html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'jetpackdoc' +htmlhelp_basename = 'jetplotdoc' # -- Options for LaTeX output --------------------------------------------- @@ -227,7 +227,7 @@ # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'jetpack.tex', u'jetpack Documentation', + (master_doc, 'jetplot.tex', u'jetplot Documentation', u'Niru Maheswaranathan', 'manual'), ] @@ -257,7 +257,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'jetpack', u'jetpack Documentation', + (master_doc, 'jetplot', u'jetplot Documentation', [author], 1) ] @@ -271,8 +271,8 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'jetpack', u'jetpack Documentation', - author, 'jetpack', 'One line description of project.', + (master_doc, 'jetplot', u'jetplot Documentation', + author, 'jetplot', 'One line description of project.', 'Miscellaneous'), ] diff --git a/docs/index.rst b/docs/index.rst index 2091154..fc2c259 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,12 +1,12 @@ -.. jetpack documentation master file, created by +.. jetplot documentation master file, created by sphinx-quickstart on Fri Oct 2 14:49:15 2015. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Jetpack +Jetplot ======= -Jetpack consists of the following modules: +Jetplot consists of the following modules: Timepiece