Segregated documentation, added bibliography

.gitignore

@@ -2,4 +2,5 @@
 *.jl.cov
 *.jl.mem
 /docs/build/
-Manifest.toml
+Manifest.toml
+auto/

docs/Project.toml

@@ -2,6 +2,7 @@
 AtomicLevels = "10933b4c-d60f-11e8-1fc6-bd9035a249a1"
 CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
 HalfIntegers = "f0d1745a-41c9-11e9-1dd9-e5d34d218721"
 LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 

docs/make.jl

@@ -1,15 +1,21 @@
 using Documenter
+using DocumenterCitations
 using Hydrogen
 using HalfIntegers, AtomicLevels
 using CairoMakie
 using LaTeXStrings
 
+bib = CitationBibliography(joinpath(@__DIR__, "src", "bibliography.bib"))
+
 makedocs(;
     modules=[Hydrogen],
     sitename="Hydrogen.jl",
     pages=[
         "Home" => "index.md",
+        "Energies" => "energies.md",
         "Orbitals" => "orbitals.md",
+        "Dipoles" => "dipoles.md",
+        "References" => "references.md",
     ],
     format = Documenter.HTML(
         mathengine = MathJax2(Dict(:TeX => Dict(
@@ -47,6 +53,7 @@ makedocs(;
             ),
         ))),
     ),
+    plugins=[bib],
     doctest = false
 )
 

docs/src/bibliography.bib

@@ -0,0 +1,22 @@
+% All entries have to have consistent casing for the keys until
+% https://github.com/Humans-of-Julia/BibParser.jl/issues/28 is fixed!
+
+@book{Bethe1977,
+  address =      {New York},
+  author =       {Bethe, Hans and Salpeter, Edwin},
+  isbn =         {978-0-306-20022-9},
+  publisher =    {Plenum Pub. Corp},
+  title =        {Quantum mechanics of one-and two-electron atoms},
+  year =         1977
+}
+
+@article{Burgess1965,
+  author =       {{Burgess}, A.},
+  title =        {Tables of hydrogenic photoionization cross-sections
+                  and recombination coefficients},
+  journal =      {Monthly Notices of the Royal Astronomical Society},
+  year =         1965,
+  volume =       69,
+  pages =        1,
+  url =          {http://adsabs.harvard.edu/abs/1965MmRAS..69....1B},
+}

docs/src/dipoles.md

@@ -0,0 +1,7 @@
+# Dipoles
+
+```@docs
+Hydrogen.dipole_moment
+Hydrogen.radial_dipole_moment
+Hydrogen.dipole_matrix
+```

docs/src/energies.md

@@ -0,0 +1,8 @@
+# Energies
+
+```@docs
+Hydrogen.non_relativistic_energy
+Hydrogen.relativistic_energy
+Hydrogen.orbital_energy
+Hydrogen.atomic_hamiltonian
+```

docs/src/index.md

@@ -4,17 +4,13 @@ CurrentModule = Hydrogen
 
 # Hydrogen
 
-Equations tagged (BSXX.YY) reference
-
-- Bethe, H., & Salpeter, E. (1977). Quantum mechanics of one-and
-  two-electron atoms. New York: Plenum Pub. Corp.
+Equations tagged (BSXX.YY) reference [Bethe1977](@citet).
 
 All angular integrals are computed using
 [AngularMomentumAlgebra.jl](https://github.com/JuliaAtoms/AngularMomentumAlgebra.jl).
 
-```@index
-```
+# Reference
 
-```@autodocs
-Modules = [Hydrogen]
+```@docs
+Hydrogen.factorial_ratio
 ```

docs/src/orbitals.md

@@ -1,7 +1,14 @@
 # Orbitals
 
+```@docs
+Hydrogen.non_relativistic_orbital
+```
+
+Continuum orbitals for hydrogenic systems can be computed using
+[CoulombFunctions.jl](https://github.com/jagot/CoulombFunctions.jl).
+
 [`non_relativistic_orbital`](@ref) is can be used to calculate the non-relativistic reduced
-radial orbitals:
+radial orbitals for bound states:
 
 ```@setup
 using Hydrogen, CairoMakie, LaTeXStrings

docs/src/references.md

@@ -0,0 +1,4 @@
+# References
+
+```@bibliography
+```