Skip to content

Commit e392102

Browse files
authored
Sdg23 add documentation page (#445)
* add top level page for documentation * part of addressing issue #441 * FIX broken links * add mamba instructions and refine installation quick start
1 parent 5659008 commit e392102

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

pages/documentation.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: page
3+
title: Documentation
4+
order: 3
5+
---
6+
7+
MDAnalysis is an open-source, available under the [GNU Lesser General Public License, version 2.1 or later (LGPLv2.1+)](https://www.gnu.org/licenses/lgpl-2.1.html). MDAnalysis provides **comprehensive documentation** to help users at all levels—whether you're just getting started, developing new tools, or contributing to the project. From **step-by-step tutorials** to an in-depth **API reference**, these resources will guide you through installing, using, and extending MDAnalysis.
8+
9+
## User Guide
10+
The [User Guide]({{ site.docs.userguide.url }}) is the best place for new users to start. It includes:
11+
12+
- [Installation instructions]({{ site.docs.userguide.url }}/stable/installation.html)
13+
- Tutorials and [examples]({{ site.docs.userguide.url }}/stable/examples/README.html)
14+
- Detailed explanations of MDAnalysis functionalities (see for example the [`AtomGroup`]({{ site.docs.userguide.url }}/stable/atomgroup.html))
15+
16+
## API Reference
17+
The [API Reference]({{ site.docs.mdanalysis.url }}) offers detailed documentation on all MDAnalysis modules, classes, and functions—perfect for developers and advanced users.
18+
19+
## MDAnalysis Paper
20+
Learn about the design philosophy and scientific impact of MDAnalysis in the [MDAnalysis paper]({{ site.baseurl }}/pages/citations#Gowers2016).
21+
22+
---
23+
24+
If you need help or have ideas, visit our [Community]({{ site.baseurl }}/pages/community) page to learn about available discussion channels.
25+

0 commit comments

Comments
 (0)