Skip to content

Commit

Permalink
docs revisions
Browse files Browse the repository at this point in the history
  • Loading branch information
bmorris3 committed Sep 20, 2023
1 parent 43a32fc commit d114781
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 15 deletions.
23 changes: 16 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
# See astropy.sphinx.conf for which values are set there.

from configparser import ConfigParser
from astroplan import __version__
import sys
import datetime
from importlib import metadata

try:
from sphinx_astropy.conf.v2 import * # noqa
Expand Down Expand Up @@ -70,10 +70,17 @@
__import__(project)
package = sys.modules[project]

# The short X.Y version.
version = package.__version__.split('-', 1)[0]
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.

# The full version, including alpha/beta/rc tags.
release = package.__version__
release = metadata.version(project)
# The short X.Y version.
version = ".".join(release.split(".")[:2])

# Only include dev docs in dev version.
dev = "dev" in release


# -- Options for HTML output ---------------------------------------------------
Expand Down Expand Up @@ -173,9 +180,6 @@
# -- Turn on nitpicky mode for sphinx (to warn about references not found) ----
nitpicky = True

release = __version__
dev = "dev" in release

html_copy_source = False

html_theme_options.update( # noqa: F405
Expand All @@ -198,6 +202,11 @@
"doc_path": "docs",
}

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
html_extra_path = ["robots.txt"]

#
# Some warnings are impossible to suppress, and you can list specific references
# that should be ignored in a nitpick-exceptions file which should be inside
Expand Down
11 changes: 3 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ License: BSD-3

.. _astroplan_docs:

General Documentation
=====================
Documentation
=============

.. toctree::
:maxdepth: 2
Expand All @@ -44,13 +44,8 @@ General Documentation
api
changelog

.. _astroplan_authors:

Authors
=======

Maintainers
-----------
+++++++++++
* `Brett Morris, including contributions from Google Summer of Code 2015 <https://www.google-melange.com/gsoc/project/details/google/gsoc2015/bmmorris/5707702298738688>`_

Attribution
Expand Down

0 comments on commit d114781

Please sign in to comment.