Skip to content

Commit

Permalink
Remove DEV_DOCS.md symlinking
Browse files Browse the repository at this point in the history
The link doesn't work properly since the symlink isn't included in the
rST tree.

Instead of including the symlink in the rST tree, remove it and
reference the file directly.
  • Loading branch information
victorlin committed Mar 9, 2023
1 parent 2107e62 commit f0fda9d
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 15 deletions.
1 change: 0 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'README.md',
'narratives',
'contributing',
]


Expand Down
12 changes: 0 additions & 12 deletions docs/contributing/index.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/contributing/overview.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/releases/v2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Backstory

Auspice started as the `nextstrain.org <https://nextstrain.org>`__ visualisation tool, in fact for a long time nextstrain.org *was* Auspice. Slowly, we turned Auspice into a stand-alone tool and started expanding its capacity. This resulted in many v1.x releases (we made it all the way to v1.39.0), and things had a habit of changing a little too frequently, with not enough focus on documentation and communication.

So in a way, this is the first proper Auspice release! There are a few big and visible changes, including using pie charts to represent discrete variables on a map, but a lot of the changes were done to make things easier behind the scenes. There are also a bunch of really cool features such as the ability to define custom servers, change the aesthetics of the Auspice client, display multiple trees and write narratives which were technically part of Auspice v1 but undocumented. This documentation website is now up to date and should allow you to understand how to use Auspice to its full potential (`contributions are always welcome! <../contributing/overview.md>`__)
So in a way, this is the first proper Auspice release! There are a few big and visible changes, including using pie charts to represent discrete variables on a map, but a lot of the changes were done to make things easier behind the scenes. There are also a bunch of really cool features such as the ability to define custom servers, change the aesthetics of the Auspice client, display multiple trees and write narratives which were technically part of Auspice v1 but undocumented. This documentation website is now up to date and should allow you to understand how to use Auspice to its full potential (`contributions are always welcome! <https://github.com/nextstrain/auspice/blob/-/DEV_DOCS.md>`__)

In general, we hope that this documentation and the help messages of the various ``auspice`` subcommands are vastly improved. The major changes which Auspice v2 brings are detailed below 👇 If you have any comments please `email us <mailto:[email protected]>`__ or say hi on `twitter <https://twitter.com/nextstrain>`__.

Expand Down

0 comments on commit f0fda9d

Please sign in to comment.