Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
980cfd9
WIP updates
taldcroft Mar 26, 2024
cd6cf84
Remove coding guide info for emacs
taldcroft Apr 20, 2024
f9cd5e9
Add a copy of pandas development docs
taldcroft Apr 20, 2024
d23952e
Add pandas-based development docs to index
taldcroft Apr 20, 2024
52d7511
Remove a codespell false positive
taldcroft Apr 20, 2024
81bf5be
Remove {{header}} from pd-based docs
taldcroft Apr 20, 2024
5a4b5fa
Replace pandas-dev/pandas with astropy/astropy
taldcroft Apr 20, 2024
6958918
Replace pandas with astropy
taldcroft Apr 20, 2024
98f6d8f
Touch-ups on contributing.rst
taldcroft Apr 30, 2024
85a927c
Bring the pandas files into the main dev dir
taldcroft Jun 11, 2024
9e7912f
More updates
taldcroft Jun 12, 2024
cfa8846
More updates
taldcroft Jun 12, 2024
126fac4
Remove contributing different ways (superceded)
taldcroft Jun 12, 2024
cf5b7f6
Remove non-applicable pandas content
taldcroft Jun 12, 2024
4f9b527
More changes
taldcroft Jun 12, 2024
7e36709
More updates
taldcroft Jun 12, 2024
cf5afe5
Update git_edit_workflow_examples
taldcroft Jun 12, 2024
27e1f01
More updates
taldcroft Jun 12, 2024
683648a
More changes
taldcroft Jun 13, 2024
18ab92c
Remove pytest-pep8
taldcroft Jun 13, 2024
c69b106
Additional pytest-pep8 removal
taldcroft Jun 13, 2024
127244e
Put tox into dev_all
taldcroft Jun 13, 2024
24100b5
Mostly finished with testing guide
taldcroft Jun 13, 2024
9f4854c
Remove pandas contributing codebase
taldcroft Jun 13, 2024
e81e0cf
More tweaks to testing guide
taldcroft Jun 13, 2024
bd0662d
First pass at the documentation guide
taldcroft Jun 13, 2024
046d5f3
Remove pandas contributing_documentation
taldcroft Jun 13, 2024
8709524
Remove pandas doc files part duex
taldcroft Jun 13, 2024
bcbf39e
More changes
taldcroft Jun 13, 2024
4b07d75
Move git_resources out of workflow
taldcroft Jun 13, 2024
d6c9ab5
Make one quickstart doc
taldcroft Jun 13, 2024
ee9b0b2
Move the remaining bits from workflow dir
taldcroft Jun 13, 2024
7109e9f
Remove building and virtual_pythons docs
taldcroft Jun 13, 2024
8d2842a
More changes
taldcroft Jun 13, 2024
ca24e95
More changes
taldcroft Jun 13, 2024
8eca000
More changes
taldcroft Jun 14, 2024
3104360
More changes
taldcroft Jun 14, 2024
ca0799f
Another tweak
taldcroft Jun 14, 2024
9c1bb02
Change target links to anonymous [skip ci]
taldcroft Jun 14, 2024
7dbedce
Remove doc refs to `astropy.test()`; replace w/ pytest
taldcroft Jun 19, 2024
95ad5bc
Respond to review comments
taldcroft Jun 19, 2024
78e6de8
Apply suggestions from code review
taldcroft Jun 19, 2024
3cab9eb
Address more review comments [skip ci]
taldcroft Jun 21, 2024
529f940
More comments; use git switch in non-maintainer docs
taldcroft Jun 21, 2024
4f3d8b6
Fix typo in git switch command
taldcroft Jun 21, 2024
693b691
Apply suggestions from code review
taldcroft Jun 26, 2024
d4eb5d4
Revert code changes related to pep8
taldcroft Jun 26, 2024
1684304
More updates and review comments [ci skip]
taldcroft Jun 26, 2024
fa8558b
Add What's New and changelog entries
taldcroft Jun 27, 2024
8da1dab
Update docs/development/quickstart.rst [ci skip]
taldcroft Jun 30, 2024
1e42733
Address more review comments [ci skip]
taldcroft Jun 30, 2024
9cd1ea5
Move is_development statement for clarity
taldcroft Jul 1, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/changes/16561.other.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
The Contributor documentation has been significantly improved. It now includes a
Quickstart Guide with concise instructions on setting up a development environment and
making a pull request. In addition, the developer documentation was reorganized and
simplified where possible to improve readability and accessibility.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@ def rstjinja(app, docname, source):
# Make sure we're outputting HTML
if app.builder.format != "html":
return
files_to_render = ["index_dev", "install"]
files_to_render = ["development/index", "install"]
if docname in files_to_render:
logger.info("Jinja rendering %s", docname)
rendered = app.builder.templates.render_string(
Expand Down
54 changes: 0 additions & 54 deletions docs/development/building.rst

This file was deleted.

15 changes: 1 addition & 14 deletions docs/development/codeguide.rst
Comment thread
pllim marked this conversation as resolved.
Resolved
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Interface and Dependencies
<https://github.com/astropy/astropy/blob/main/pyproject.toml>`_ file of the
core package.

* Usage of ``six``, ``__future__``, and ``2to3`` is no longer acceptable.
* Usage of ``six`` and ``2to3`` is no longer acceptable.

* `f-strings <https://docs.python.org/3/reference/lexical_analysis.html#f-strings>`_
should be used when possible, and if not, Python 3
Expand Down Expand Up @@ -188,8 +188,6 @@ Coding Style/Conventions

.. note:: There are multiple options for testing PEP8 compliance of code,
see :doc:`testguide` for more information.
See :doc:`codeguide_emacs` for some configuration options for Emacs
Comment thread
taldcroft marked this conversation as resolved.
Resolved
that helps in ensuring conformance to PEP8.

* ``astropy`` source code should contain a comment at the beginning of the file
pointing to the license for the ``astropy`` source code. This line should say::
Expand Down Expand Up @@ -546,17 +544,6 @@ might read::
This ensures that ``from submodule import *`` only imports ``foo`` and
``AClass``, but not `numpy.array` or `numpy.linspace`.


Additional Resources
====================

Further tips and hints relating to the coding guidelines are included below.

.. toctree::
:maxdepth: 1

codeguide_emacs

.. _Numpy: https://numpy.org/
.. _Scipy: https://www.scipy.org/
.. _matplotlib: https://matplotlib.org/
Expand Down
69 changes: 0 additions & 69 deletions docs/development/codeguide_emacs.rst

This file was deleted.

Loading