Skip to content

Commit

Permalink
Fix docs badge and logo on index page (#17)
Browse files Browse the repository at this point in the history
* Fixed docs tag and added logo to docs index

* Removed license and corrected doc links in README

* Trying removing the hidden HTML

* Trying with more space

* Adding close div to bottom

* I give up, changed the heading
  • Loading branch information
eytanadler authored Aug 2, 2022
1 parent 1f5a188 commit 3c5d1ca
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 12 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
</h2>

[![Build Status](https://dev.azure.com/mdolab/Public/_apis/build/status/mdolab.CMPLXFOIL?repoName=mdolab%2FCMPLXFOIL&branchName=main)](https://dev.azure.com/mdolab/Public/_build/latest?definitionId=45&repoName=mdolab%2FCMPLXFOIL&branchName=main)
[![Documentation Status](https://readthedocs.com/projects/mdolab-pyxlight/badge/?version=latest&token=7a9e7987d2288b741e09686619f4cd425b1a7348ebbcca59c0d20b2ad5a003f6)](https://mdolab-pyxlight.readthedocs-hosted.com/en/latest/?badge=latest)
[![Documentation Status](https://readthedocs.com/projects/mdolab-cmplxfoil/badge/?version=latest&token=79105dee7e015d89159cb837b8f5301e6ec5fa28acb4aec0b5cb06ad1cc06f48)](https://mdolab-cmplxfoil.readthedocs-hosted.com/en/latest/?badge=latest)

CMPLXFOIL is a version of Mark Drela's XFOIL code with the GUI features removed.
Gradient computation is implemented with the complex-step method.
Expand All @@ -14,17 +14,11 @@ Gradient computation is implemented with the complex-step method.

Documentation
-------------
Please see the [documentation](https://mdolab-pyxlight.readthedocs-hosted.com/en/latest/) for installation and usage details.
Please see the [documentation](https://mdolab-cmplxfoil.readthedocs-hosted.com/en/latest/) for installation and usage details.

To locally build the documentation, enter the ``doc`` folder and run ``make html`` in the command line prompt.
You can then view the built documentation in the ``doc/_build/html/`` by opening ``index.html``.

Citing CMPLXFOIL
---------------
If you use CMPLXFOIL, please see [this page](https://mdolab-pyxlight.readthedocs-hosted.com/en/latest/citation.html) for citation information.

License
-------
Copyright 2021 MDO Lab

Distributed using the GNU General Public License (GPL), version 2.0; see the LICENSE.md file for details.
If you use CMPLXFOIL, please see [this page](https://mdolab-cmplxfoil.readthedocs-hosted.com/en/latest/citation.html) for citation information.
10 changes: 7 additions & 3 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
CMPLXFOIL
====================================
.. image:: assets/cmplxfoil_logo.svg
:width: 500
:align: center

Welcome
=======
CMPLXFOIL is a version of Mark Drela's XFOIL code with the GUI features removed.
Gradient computation is implemented with the complex-step method.
The Python interface is designed to be used with `MACH-Aero <https://mdolab-mach-aero.readthedocs-hosted.com/en/latest/index.html>`_ tools for optimization.
Expand Down Expand Up @@ -32,4 +36,4 @@ Increasing the number of panels helps (CMPLXFOIL uses 284 panels by default), bu

.. image:: assets/multimodality_cd.svg
:width: 600
:align: center
:align: center

0 comments on commit 3c5d1ca

Please sign in to comment.