integrated docs for CG_fiber dataset

- fix #27 - added CHANGELOG entry - make fetch_CG_fiber() show up in docs
MDAnalysis · Nov 6, 2018 · c4a9959 · c4a9959
1 parent 2e37637
commit c4a9959
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- new `fetch_CG_fiber()` to get CG_fiber dataset (PR #24)
+
 ### Fixes
 - fixed fetch_adk_transitions_DIMS() failed to fetch (#19)
 - added six to install requirements (#22)

diff --git a/MDAnalysisData/CG_fiber.py b/MDAnalysisData/CG_fiber.py
@@ -62,7 +62,7 @@ def fetch_CG_fiber(data_home=None, download_if_missing=True):
         Description of the trajectory.
 
 
-    See :ref:`CG_fiber` for description.
+    See :ref:`CG_fiber-dataset` for description.
     """
     name = NAME
     data_location = join(get_data_home(data_home=data_home),
@@ -83,6 +83,6 @@ def fetch_CG_fiber(data_home=None, download_if_missing=True):
                 file_type, meta.url, local_path))
             archive_path = _fetch_remote(meta, dirname=data_location)
 
-    #records.DESCR = _read_description(DESCRIPTION)
+    records.DESCR = _read_description(DESCRIPTION)
 
     return records
diff --git a/MDAnalysisData/descr/CG_fiber.rst b/MDAnalysisData/descr/CG_fiber.rst
@@ -1,9 +1,9 @@
 .. -*- coding: utf-8 -*-
 
-.. _`CG_fiber`:
+.. _`CG_fiber-dataset`:
 
-        CG  fiber dataset
-==================================
+CG fiber dataset
+================
 
 MD trajectory showing the self-assembly of an amphiphilic molecule.
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -89,3 +89,4 @@ of pull requests are very welcome.
    ifabp_water
    nhaa_equilibrium
    vesicles
+   CG_fiber
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -21,6 +21,7 @@ represent.  The currently included datasets are:
    ifabp_water
    nhaa_equilibrium
    vesicles
+   CG_fiber
 
 Accessing a dataset
 ===================